@enbox/gitd 0.0.1

package/dist/types/issues.d.ts

@@ -0,0 +1,395 @@
+/**
+ * Forge Issues Protocol — issue tracking with comments, labels, and status changes.
+ *
+ * Composes with the Forge Repo protocol via `uses` for role-based authorization.
+ * Only users with a contributor, triager, or maintainer role can create issues
+ * directly on the repo owner's DWN. External issue reports live on the reporter's
+ * own DWN and are surfaced via indexers.
+ *
+ * @module
+ */
+/** Data shape for an issue record. */
+export type IssueData = {
+    title: string;
+    body: string;
+    number?: number;
+};
+/** Data shape for a comment on an issue. */
+export type CommentData = {
+    body: string;
+};
+/** Data shape for a reaction on a comment. */
+export type ReactionData = {
+    emoji: string;
+};
+/** Data shape for a label application on an issue. */
+export type LabelData = {
+    name: string;
+    color: string;
+};
+/** Data shape for an issue status change event. */
+export type StatusChangeData = {
+    reason?: string;
+};
+/** Data shape for an issue assignment. */
+export type AssignmentData = {
+    assigneeDid: string;
+    alias?: string;
+};
+/** Maps protocol type names to their TypeScript data shapes. */
+export type ForgeIssuesSchemaMap = {
+    issue: IssueData;
+    comment: CommentData;
+    reaction: ReactionData;
+    label: LabelData;
+    statusChange: StatusChangeData;
+    assignment: AssignmentData;
+};
+export declare const ForgeIssuesDefinition: {
+    readonly protocol: "https://enbox.org/protocols/forge/issues";
+    readonly published: true;
+    readonly uses: {
+        readonly repo: "https://enbox.org/protocols/forge/repo";
+    };
+    readonly types: {
+        readonly issue: {
+            readonly schema: "https://enbox.org/schemas/forge/issue";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly comment: {
+            readonly schema: "https://enbox.org/schemas/forge/comment";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly reaction: {
+            readonly schema: "https://enbox.org/schemas/forge/reaction";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly label: {
+            readonly schema: "https://enbox.org/schemas/forge/label";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly statusChange: {
+            readonly schema: "https://enbox.org/schemas/forge/status-change";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly assignment: {
+            readonly schema: "https://enbox.org/schemas/forge/assignment";
+            readonly dataFormats: ["application/json"];
+        };
+    };
+    readonly structure: {
+        readonly repo: {
+            readonly $ref: "repo:repo";
+            readonly issue: {
+                readonly $actions: [{
+                    readonly role: "repo:repo/contributor";
+                    readonly can: ["create", "read"];
+                }, {
+                    readonly role: "repo:repo/maintainer";
+                    readonly can: ["create", "read", "update", "delete"];
+                }, {
+                    readonly role: "repo:repo/triager";
+                    readonly can: ["create", "read", "co-update"];
+                }, {
+                    readonly who: "author";
+                    readonly of: "repo/issue";
+                    readonly can: ["create", "update"];
+                }];
+                readonly $tags: {
+                    readonly $requiredTags: ["status"];
+                    readonly $allowUndefinedTags: false;
+                    readonly status: {
+                        readonly type: "string";
+                        readonly enum: ["open", "closed"];
+                    };
+                    readonly number: {
+                        readonly type: "string";
+                    };
+                    readonly priority: {
+                        readonly type: "string";
+                        readonly enum: ["low", "medium", "high", "critical"];
+                    };
+                    readonly milestone: {
+                        readonly type: "string";
+                    };
+                };
+                readonly comment: {
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["create", "read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "read", "delete"];
+                    }, {
+                        readonly who: "author";
+                        readonly of: "repo/issue/comment";
+                        readonly can: ["create", "update", "delete"];
+                    }];
+                    readonly reaction: {
+                        readonly $actions: [{
+                            readonly role: "repo:repo/contributor";
+                            readonly can: ["create", "read", "delete"];
+                        }, {
+                            readonly role: "repo:repo/maintainer";
+                            readonly can: ["create", "read", "delete"];
+                        }];
+                        readonly $tags: {
+                            readonly $requiredTags: ["emoji"];
+                            readonly $allowUndefinedTags: false;
+                            readonly emoji: {
+                                readonly type: "string";
+                                readonly maxLength: 10;
+                            };
+                        };
+                    };
+                };
+                readonly label: {
+                    readonly $immutable: true;
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "delete"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create", "delete"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["name", "color"];
+                        readonly $allowUndefinedTags: false;
+                        readonly name: {
+                            readonly type: "string";
+                        };
+                        readonly color: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly statusChange: {
+                    readonly $immutable: true;
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create"];
+                    }, {
+                        readonly who: "author";
+                        readonly of: "repo/issue";
+                        readonly can: ["create"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["from", "to"];
+                        readonly $allowUndefinedTags: false;
+                        readonly from: {
+                            readonly type: "string";
+                            readonly enum: ["open", "closed"];
+                        };
+                        readonly to: {
+                            readonly type: "string";
+                            readonly enum: ["open", "closed"];
+                        };
+                    };
+                };
+                readonly assignment: {
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "delete"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create", "delete"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["assigneeDid"];
+                        readonly $allowUndefinedTags: false;
+                        readonly assigneeDid: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+/** Typed Forge Issues protocol for use with `dwn.using()`. */
+export declare const ForgeIssuesProtocol: import("@enbox/api").TypedProtocol<{
+    readonly protocol: "https://enbox.org/protocols/forge/issues";
+    readonly published: true;
+    readonly uses: {
+        readonly repo: "https://enbox.org/protocols/forge/repo";
+    };
+    readonly types: {
+        readonly issue: {
+            readonly schema: "https://enbox.org/schemas/forge/issue";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly comment: {
+            readonly schema: "https://enbox.org/schemas/forge/comment";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly reaction: {
+            readonly schema: "https://enbox.org/schemas/forge/reaction";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly label: {
+            readonly schema: "https://enbox.org/schemas/forge/label";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly statusChange: {
+            readonly schema: "https://enbox.org/schemas/forge/status-change";
+            readonly dataFormats: ["application/json"];
+        };
+        readonly assignment: {
+            readonly schema: "https://enbox.org/schemas/forge/assignment";
+            readonly dataFormats: ["application/json"];
+        };
+    };
+    readonly structure: {
+        readonly repo: {
+            readonly $ref: "repo:repo";
+            readonly issue: {
+                readonly $actions: [{
+                    readonly role: "repo:repo/contributor";
+                    readonly can: ["create", "read"];
+                }, {
+                    readonly role: "repo:repo/maintainer";
+                    readonly can: ["create", "read", "update", "delete"];
+                }, {
+                    readonly role: "repo:repo/triager";
+                    readonly can: ["create", "read", "co-update"];
+                }, {
+                    readonly who: "author";
+                    readonly of: "repo/issue";
+                    readonly can: ["create", "update"];
+                }];
+                readonly $tags: {
+                    readonly $requiredTags: ["status"];
+                    readonly $allowUndefinedTags: false;
+                    readonly status: {
+                        readonly type: "string";
+                        readonly enum: ["open", "closed"];
+                    };
+                    readonly number: {
+                        readonly type: "string";
+                    };
+                    readonly priority: {
+                        readonly type: "string";
+                        readonly enum: ["low", "medium", "high", "critical"];
+                    };
+                    readonly milestone: {
+                        readonly type: "string";
+                    };
+                };
+                readonly comment: {
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["create", "read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "read", "delete"];
+                    }, {
+                        readonly who: "author";
+                        readonly of: "repo/issue/comment";
+                        readonly can: ["create", "update", "delete"];
+                    }];
+                    readonly reaction: {
+                        readonly $actions: [{
+                            readonly role: "repo:repo/contributor";
+                            readonly can: ["create", "read", "delete"];
+                        }, {
+                            readonly role: "repo:repo/maintainer";
+                            readonly can: ["create", "read", "delete"];
+                        }];
+                        readonly $tags: {
+                            readonly $requiredTags: ["emoji"];
+                            readonly $allowUndefinedTags: false;
+                            readonly emoji: {
+                                readonly type: "string";
+                                readonly maxLength: 10;
+                            };
+                        };
+                    };
+                };
+                readonly label: {
+                    readonly $immutable: true;
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "delete"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create", "delete"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["name", "color"];
+                        readonly $allowUndefinedTags: false;
+                        readonly name: {
+                            readonly type: "string";
+                        };
+                        readonly color: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+                readonly statusChange: {
+                    readonly $immutable: true;
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create"];
+                    }, {
+                        readonly who: "author";
+                        readonly of: "repo/issue";
+                        readonly can: ["create"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["from", "to"];
+                        readonly $allowUndefinedTags: false;
+                        readonly from: {
+                            readonly type: "string";
+                            readonly enum: ["open", "closed"];
+                        };
+                        readonly to: {
+                            readonly type: "string";
+                            readonly enum: ["open", "closed"];
+                        };
+                    };
+                };
+                readonly assignment: {
+                    readonly $actions: [{
+                        readonly role: "repo:repo/contributor";
+                        readonly can: ["read"];
+                    }, {
+                        readonly role: "repo:repo/maintainer";
+                        readonly can: ["create", "delete"];
+                    }, {
+                        readonly role: "repo:repo/triager";
+                        readonly can: ["create", "delete"];
+                    }];
+                    readonly $tags: {
+                        readonly $requiredTags: ["assigneeDid"];
+                        readonly $allowUndefinedTags: false;
+                        readonly assigneeDid: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, ForgeIssuesSchemaMap>;
+//# sourceMappingURL=issues.d.ts.map

package/dist/types/issues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"issues.d.ts","sourceRoot":"","sources":["../../src/issues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAUH,sCAAsC;AACtC,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,EAAG,MAAM,CAAC;IACd,MAAM,CAAC,EAAG,MAAM,CAAC;CAClB,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAG,MAAM,CAAC;CAChB,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAG,MAAM,CAAC;IACrB,KAAK,CAAC,EAAG,MAAM,CAAC;CACjB,CAAC;AAMF,gEAAgE;AAChE,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAG,SAAS,CAAC;IAClB,OAAO,EAAG,WAAW,CAAC;IACtB,QAAQ,EAAG,YAAY,CAAC;IACxB,KAAK,EAAG,SAAS,CAAC;IAClB,YAAY,EAAG,gBAAgB,CAAC;IAChC,UAAU,EAAG,cAAc,CAAC;CAC7B,CAAC;AAMF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsHK,CAAC;AAMxC,8DAA8D;AAC9D,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAG/B,CAAC"}

package/dist/types/notifications.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Forge Notifications Protocol — private notification inbox.
+ *
+ * Notifications are private (`published: false`). Only the DWN owner can
+ * read, update (mark as read), or delete. Notification senders (e.g., repo
+ * maintainers, CI bots) need a scoped permission grant to create.
+ *
+ * @module
+ */
+/** Data shape for a notification record. */
+export type NotificationData = {
+    type: string;
+    title: string;
+    body?: string;
+    repoDid?: string;
+    repoRecordId?: string;
+    sourceRecordId?: string;
+    url?: string;
+};
+/** Maps protocol type names to their TypeScript data shapes. */
+export type ForgeNotificationsSchemaMap = {
+    notification: NotificationData;
+};
+export declare const ForgeNotificationsDefinition: {
+    readonly protocol: "https://enbox.org/protocols/forge/notifications";
+    readonly published: false;
+    readonly types: {
+        readonly notification: {
+            readonly schema: "https://enbox.org/schemas/forge/notification";
+            readonly dataFormats: ["application/json"];
+        };
+    };
+    readonly structure: {
+        readonly notification: {
+            readonly $tags: {
+                readonly $requiredTags: ["type", "read"];
+                readonly $allowUndefinedTags: true;
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: ["mention", "review_request", "assignment", "ci_failure", "patch_merged", "issue_comment", "review"];
+                };
+                readonly read: {
+                    readonly type: "boolean";
+                };
+                readonly repoDid: {
+                    readonly type: "string";
+                };
+                readonly repoRecordId: {
+                    readonly type: "string";
+                };
+                readonly sourceRecordId: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+/** Typed Forge Notifications protocol for use with `dwn.using()`. */
+export declare const ForgeNotificationsProtocol: import("@enbox/api").TypedProtocol<{
+    readonly protocol: "https://enbox.org/protocols/forge/notifications";
+    readonly published: false;
+    readonly types: {
+        readonly notification: {
+            readonly schema: "https://enbox.org/schemas/forge/notification";
+            readonly dataFormats: ["application/json"];
+        };
+    };
+    readonly structure: {
+        readonly notification: {
+            readonly $tags: {
+                readonly $requiredTags: ["type", "read"];
+                readonly $allowUndefinedTags: true;
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: ["mention", "review_request", "assignment", "ci_failure", "patch_merged", "issue_comment", "review"];
+                };
+                readonly read: {
+                    readonly type: "boolean";
+                };
+                readonly repoDid: {
+                    readonly type: "string";
+                };
+                readonly repoRecordId: {
+                    readonly type: "string";
+                };
+                readonly sourceRecordId: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+}, ForgeNotificationsSchemaMap>;
+//# sourceMappingURL=notifications.d.ts.map

package/dist/types/notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../../src/notifications.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAUH,4CAA4C;AAC5C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAG,MAAM,CAAC;IACd,KAAK,EAAG,MAAM,CAAC;IACf,IAAI,CAAC,EAAG,MAAM,CAAC;IACf,OAAO,CAAC,EAAG,MAAM,CAAC;IAClB,YAAY,CAAC,EAAG,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,GAAG,CAAC,EAAG,MAAM,CAAC;CACf,CAAC;AAMF,gEAAgE;AAChE,MAAM,MAAM,2BAA2B,GAAG;IACxC,YAAY,EAAE,gBAAgB,CAAC;CAChC,CAAC;AAMF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BF,CAAC;AAMxC,qEAAqE;AACrE,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAGtC,CAAC"}