forges 0.0.0 → 0.1.0

package/dist/schema/Installation.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`."
+    },
+    "id": {
+      "type": "string"
+    },
+    "account": {
+      "$ref": "#/definitions/Actor"
+    },
+    "targetTypeRaw": {
+      "type": "string",
+      "description": "Forge-native target type, for example `Organization` or `User`."
+    },
+    "repositorySelectionRaw": {
+      "type": "string",
+      "description": "Forge-native repository selection, for example `all` or `selected`."
+    },
+    "raw": {}
+  },
+  "required": [
+    "forge",
+    "id",
+    "instance",
+    "raw"
+  ],
+  "description": "An app installation on an account, with its own credential scope.",
+  "x-forges-type": "Installation",
+  "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"
+    }
+  }
+}

package/dist/schema/InstallationToken.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "token": {
+      "type": "string"
+    },
+    "expiresAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "permissions": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "repositorySelection": {
+      "type": "string",
+      "description": "Whether the token reaches all repositories or only selected ones."
+    }
+  },
+  "required": [
+    "token",
+    "expiresAt",
+    "permissions"
+  ],
+  "description": "A short-lived token that acts as one app installation.",
+  "x-forges-type": "InstallationToken",
+  "definitions": {}
+}

package/dist/schema/KnownForgeKind.json

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

package/dist/schema/Label.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "colour": {
+      "type": "string",
+      "description": "The colour as hex digits, without a leading `#`."
+    },
+    "description": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "description": "A label that a repository defines.",
+  "x-forges-type": "Label",
+  "definitions": {}
+}

package/dist/schema/MergeMethod.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "merge",
+    "squash",
+    "rebase",
+    "rebase_merge",
+    "fast_forward_only"
+  ],
+  "description": "How a pull request is merged.",
+  "x-forges-type": "MergeMethod",
+  "definitions": {}
+}

package/dist/schema/Milestone.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Forge-native milestone id, as `threads.setMilestone` takes it."
+    },
+    "title": {
+      "type": "string"
+    },
+    "state": {
+      "type": "string",
+      "enum": [
+        "open",
+        "closed"
+      ]
+    },
+    "description": {
+      "type": "string"
+    },
+    "dueOn": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "url": {
+      "type": "string"
+    },
+    "raw": {}
+  },
+  "required": [
+    "id",
+    "title",
+    "state",
+    "raw"
+  ],
+  "description": "A milestone that groups threads.",
+  "x-forges-type": "Milestone",
+  "definitions": {}
+}