forges 0.0.0 → 0.1.0

package/dist/schema/SecurityAlert.json

@@ -0,0 +1,219 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "ref": {
+      "$ref": "#/definitions/SecurityAlertRef"
+    },
+    "kind": {
+      "$ref": "#/definitions/SecurityAlertKind"
+    },
+    "kindRaw": {
+      "type": "string"
+    },
+    "severity": {
+      "$ref": "#/definitions/SecuritySeverity"
+    },
+    "severityRaw": {
+      "type": "string"
+    },
+    "state": {
+      "type": "string",
+      "enum": [
+        "open",
+        "fixed",
+        "dismissed",
+        "unknown"
+      ]
+    },
+    "stateRaw": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string",
+      "description": "A short description of the problem."
+    },
+    "package": {
+      "type": "object",
+      "properties": {
+        "ecosystem": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "vulnerableRange": {
+          "type": "string"
+        },
+        "fixedIn": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "description": "`ecosystem` is absent where the forge reports only the package name."
+    },
+    "url": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "dismissedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "raw": {}
+  },
+  "required": [
+    "ref",
+    "kind",
+    "kindRaw",
+    "severity",
+    "state",
+    "stateRaw",
+    "title",
+    "raw"
+  ],
+  "description": "A security alert on a repository.",
+  "x-forges-type": "SecurityAlert",
+  "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"
+    },
+    "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"
+    },
+    "SecuritySeverity": {
+      "type": "string",
+      "enum": [
+        "critical",
+        "high",
+        "medium",
+        "low",
+        "unknown"
+      ],
+      "description": "How severe an alert is. `unknown` is a level that the model does not name.",
+      "x-forges-type": "SecuritySeverity"
+    }
+  }
+}

package/dist/schema/SecurityAlertKind.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "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",
+  "definitions": {}
+}

package/dist/schema/SecurityAlertRef.json

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

package/dist/schema/SecuritySeverity.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "critical",
+    "high",
+    "medium",
+    "low",
+    "unknown"
+  ],
+  "description": "How severe an alert is. `unknown` is a level that the model does not name.",
+  "x-forges-type": "SecuritySeverity",
+  "definitions": {}
+}

package/dist/schema/SourceKind.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "poll",
+    "webhook",
+    "subscribe"
+  ],
+  "description": "How an event reached the caller.",
+  "x-forges-type": "SourceKind",
+  "definitions": {}
+}

package/dist/schema/SubscriptionState.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "subscribed",
+    "ignored",
+    "none"
+  ],
+  "description": "Whether the account gets notifications for a thread.",
+  "x-forges-type": "SubscriptionState",
+  "definitions": {}
+}

package/dist/schema/Support.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "anyOf": [
+    {
+      "type": "boolean"
+    },
+    {
+      "type": "string",
+      "const": "emulated"
+    },
+    {
+      "type": "string",
+      "const": "experimental"
+    },
+    {
+      "type": "string",
+      "const": "unverified"
+    }
+  ],
+  "description": "Capability flag. Every value other than `false` means the operation is available:\n\n- `true`: native, and verified against the forge's responses.\n- `'experimental'`: native and verified, but built on an API the forge marks unstable, so it can change.\n- `'emulated'`: composed from other calls, so the result is approximate.\n- `'unverified'`: implemented, but not yet verified against the forge's responses, so it may not work.",
+  "x-forges-type": "Support",
+  "definitions": {}
+}

package/dist/schema/Tag.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "sha": {
+      "type": "string",
+      "description": "Commit the tag points at, after dereferencing an annotated tag where the forge does so."
+    },
+    "url": {
+      "type": "string"
+    },
+    "raw": {}
+  },
+  "required": [
+    "name",
+    "sha",
+    "raw"
+  ],
+  "description": "A tag of a repository.",
+  "x-forges-type": "Tag",
+  "definitions": {}
+}

package/dist/schema/TextLimits.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "bodyLength": {
+      "type": "number"
+    },
+    "commentLength": {
+      "type": "number"
+    },
+    "labelLength": {
+      "type": "number"
+    }
+  },
+  "description": "Maximum lengths the forge accepts, in characters.",
+  "x-forges-type": "TextLimits",
+  "definitions": {}
+}