@openma/matter-gitlab 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Open Managed Agents Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,11 @@
-# Temporary Holding Version
+# `@openma/matter-gitlab`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+GitLab for OpenMatter. Covers gitlab.com and self-managed GitLab.
+
+| Import                       | Contents                                                                                                           |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `@openma/matter-gitlab/bond` | Bond provider: OAuth (PKCE) user links, bot credentials, request classification, attribution, receive-pack parsing |
+
+The Bond kernel it plugs into is `@openma/matter/bond`. See
+[docs/BONDS.md](https://github.com/openma-ai/OpenMatter/blob/main/docs/BONDS.md)
+for the flow, token custody, and security notes.

package/dist/bond/index.d.ts

@@ -0,0 +1,304 @@
+import { BondProvider, ProviderError, SecretRef, TokenGrant } from "@openma/matter/bond";
+import { Effect } from "effect";
+//#region src/bond/http.d.ts
+type Fetch = typeof globalThis.fetch;
+/**
+ * Normalizes a GitLab instance URL to its canonical https origin. Rejects
+ * plain http except for loopback hosts, and rejects paths, credentials,
+ * queries, and fragments.
+ */
+declare const canonicalOrigin: (input: string) => string;
+//#endregion
+//#region src/bond/oauth.d.ts
+/**
+ * What discovery verified. OAuth calls always use the instance's fixed
+ * `/oauth/authorize`, `/oauth/token`, and `/oauth/revoke` under `origin`, so
+ * discovery returns no endpoints that callers might follow elsewhere.
+ */
+interface GitLabInstance {
+  readonly origin: string;
+  /** Whether the instance enables the device authorization grant. */
+  readonly deviceFlow: boolean;
+}
+/**
+ * Reads OIDC discovery and requires authorization code with PKCE S256 and
+ * refresh tokens, and an issuer equal to the instance origin. Device flow is
+ * recorded when present; GitLab can disable it per instance.
+ */
+declare const discoverInstance: (origin: string, fetchImpl?: Fetch) => Effect.Effect<GitLabInstance, ProviderError>;
+interface Pkce {
+  readonly verifier: string;
+  readonly challenge: string;
+  readonly method: "S256";
+}
+/** A fresh PKCE verifier and its S256 challenge. Keep the verifier server-side. */
+declare const createPkce: () => Effect.Effect<Pkce>;
+interface AuthorizationUrlInput {
+  readonly origin: string;
+  readonly clientId: string;
+  readonly redirectUri: string;
+  readonly scopes: readonly string[];
+  /** Signed, single-use state bound to the user and ProviderApp. */
+  readonly state: string;
+  readonly codeChallenge: string;
+}
+declare const authorizationUrl: (input: AuthorizationUrlInput) => string;
+interface OAuthClient {
+  readonly origin: string;
+  readonly clientId: string;
+  /** Absent for public clients. */
+  readonly clientSecret?: string;
+  readonly fetch?: Fetch;
+  /** ISO now, for computing expiry. */
+  readonly clock?: () => string;
+}
+/** Exchanges an authorization code. A wrong verifier does not consume the code on GitLab. */
+declare const exchangeCode: (client: OAuthClient, input: {
+  readonly code: string;
+  readonly redirectUri: string;
+  readonly codeVerifier: string;
+}) => Effect.Effect<TokenGrant, ProviderError, never>;
+/**
+ * Refreshes a user token. GitLab rotates both tokens and invalidates the old
+ * access token immediately, and does not detect refresh-token reuse, so the
+ * caller must hold the Bond refresh lease.
+ */
+declare const refreshAccessToken: (client: OAuthClient, refreshToken: string) => Effect.Effect<TokenGrant, ProviderError, never>;
+/**
+ * Revokes one access or refresh token. GitLab (Doorkeeper) stores an access
+ * token and its refresh token as one record, so revoking either ends that
+ * pair only. Other tokens the same user holds for the same application keep
+ * working: on a live instance, revoking the previous token after a relink left
+ * the new one valid.
+ */
+declare const revokeToken: (client: OAuthClient, token: string) => Effect.Effect<undefined, ProviderError, never>;
+//#endregion
+//#region src/bond/tokens.d.ts
+/** `GET /api/v4/user`. Numeric `id` is the stable key; the rest is display data. */
+interface GitLabUser {
+  readonly id: string;
+  readonly username: string;
+  readonly name: string;
+  readonly commitEmail?: string;
+  readonly bot: boolean;
+  readonly identities: readonly {
+    readonly provider: string;
+    readonly externUid: string;
+  }[];
+}
+/** `GET /api/v4/personal_access_tokens/self`. Works for personal, project, and group access tokens. */
+interface GitLabTokenInfo {
+  readonly id: string;
+  readonly name: string;
+  readonly active: boolean;
+  readonly revoked: boolean;
+  readonly scopes: readonly string[];
+  /** `YYYY-MM-DD`, or undefined for a token without expiry. */
+  readonly expiresAt?: string;
+  readonly userId: string;
+}
+declare const readUser: (origin: string, token: string, fetchImpl?: Fetch) => Effect.Effect<GitLabUser, ProviderError>;
+declare const readTokenInfo: (origin: string, token: string, fetchImpl?: Fetch) => Effect.Effect<GitLabTokenInfo, ProviderError>;
+/** `DELETE /api/v4/personal_access_tokens/self`: a token revokes itself. */
+declare const revokeSelfToken: (origin: string, token: string, fetchImpl?: Fetch) => Effect.Effect<void, ProviderError>;
+interface TokenPolicy {
+  readonly allowedScopes: readonly string[];
+  readonly maxLifetimeDays: number;
+  /** ISO now. */
+  readonly now: string;
+}
+type TokenProblem = "inactive" | "revoked" | "no_expiry" | "expired" | "lifetime_exceeded" | "scope_not_allowed" | "not_a_bot" | "is_a_bot" | "user_mismatch";
+/** End of the UTC expiry day, which is when GitLab stops accepting the token. */
+declare const tokenExpiryInstant: (expiresAt: string) => string;
+/**
+ * Checks a pasted personal access token: active, scopes within the allowed
+ * set, an expiry within the maximum lifetime, and a human owner.
+ */
+declare const validatePersonalAccessToken: (info: GitLabTokenInfo, user: GitLabUser, policy: TokenPolicy) => readonly TokenProblem[];
+/**
+ * Checks a bot credential registered as an Installation: the same token
+ * checks, plus `bot: true` on its user. A human account's token is never
+ * accepted as an app principal.
+ */
+declare const validateBotCredential: (info: GitLabTokenInfo, user: GitLabUser, policy: TokenPolicy) => readonly TokenProblem[];
+//#endregion
+//#region src/bond/classify.d.ts
+type GitLabOperation = "fetch" | "push" | "read" | "open_mr" | "comment_mr";
+/**
+ * A normalized project reference. Paths are lower-cased and stripped of
+ * `.git`; numeric IDs stay numeric. Both forms name one project only after
+ * the application resolves them through GitLab.
+ */
+type ProjectRef = {
+  readonly kind: "id";
+  readonly id: number;
+} | {
+  readonly kind: "path";
+  readonly path: string;
+};
+type GitLabRequestClass = {
+  readonly allow: true;
+  readonly projectRef: ProjectRef;
+  readonly operation: GitLabOperation;
+  /** `git` for smart HTTP, `rest` for `/api/v4`. */
+  readonly surface: "git" | "rest";
+  /**
+   * For `rest`: the validated path after `/api/v4/projects/<ref>`, to
+   * append to the resolved numeric project ID. For `open_mr`, the proxy
+   * must also check the body with `mergeRequestBodyProblem`.
+   */
+  readonly restTail?: string;
+} | {
+  readonly allow: false;
+  readonly reason: string;
+};
+/**
+ * Classifies one request in GitLab's own URL shape. Allows git smart HTTP
+ * fetch and push, REST reads of a project, merge request creation, and
+ * merge request notes. Denies GraphQL, LFS, archives, raw files, and every
+ * other route.
+ */
+declare const classifyGitLabRequest: (method: string, url: string | URL) => GitLabRequestClass;
+/**
+ * GitLab lets `POST /projects/:id/merge_requests` name another project in
+ * `target_project_id`, so the URL alone does not bound where the merge
+ * request opens. Returns the reason to deny, or undefined when the body
+ * targets the classified project.
+ *
+ * Pass the parsed JSON object or form body and the numeric ID the URL's
+ * project reference resolved to, then forward the body you checked
+ * (re-serialized), never the raw bytes: parsers disagree on repeated keys.
+ * For the same reason a form that repeats `target_project_id`, or uses a
+ * variant such as `target_project_id[]`, is denied.
+ */
+declare const mergeRequestBodyProblem: (body: unknown, resolvedProjectId: number) => string | undefined;
+//#endregion
+//#region src/bond/receive-pack.d.ts
+declare const ZERO_OID: string;
+interface ReceivePackCommand {
+  readonly oldId: string;
+  readonly newId: string;
+  readonly ref: string;
+}
+interface ReceivePackHead {
+  readonly commands: readonly ReceivePackCommand[];
+  readonly capabilities: readonly string[];
+  readonly options: readonly string[];
+  /** Bytes consumed by the head. The pack starts here. */
+  readonly headLength: number;
+}
+type ReceivePackParse = {
+  readonly _tag: "Complete";
+  readonly head: ReceivePackHead;
+} | {
+  readonly _tag: "Incomplete";
+} | {
+  readonly _tag: "Malformed";
+  readonly reason: string;
+};
+/** Bounds on a hostile head. Exceeding one is Malformed, never Incomplete. */
+interface ReceivePackLimits {
+  /** Default 1 MiB. */
+  readonly maxHeadBytes?: number;
+  /** Default 1000. */
+  readonly maxCommands?: number;
+  /** Default 100. */
+  readonly maxOptions?: number;
+}
+/**
+ * A strict subset of `git check-ref-format`: a full `refs/` name with no
+ * control characters, no characters git forbids, no empty, dot-leading, or
+ * `.lock` components, no `..`, and no `@{`.
+ */
+declare const isValidRefName: (ref: string) => boolean;
+interface ReceivePackHeadParser {
+  /** Feeds the next chunk of the request body. */
+  readonly push: (chunk: Uint8Array) => ReceivePackParse;
+  /**
+   * Bytes after the head in the chunk that completed it: the start of the
+   * pack. Later chunks are not buffered; stream them upstream directly.
+   */
+  readonly remainder: () => Uint8Array;
+}
+/**
+ * Incremental receive-pack head parser. Each byte is examined once, and only
+ * an unfinished pkt-line is buffered, so a head fed in many small chunks
+ * costs linear time. Capabilities are the union over every command line, as
+ * in git's `read_head`: a client cannot hide `push-options` behind a later
+ * line without them.
+ */
+declare const makeReceivePackHeadParser: (limits?: ReceivePackLimits) => ReceivePackHeadParser;
+/**
+ * Parses as much of the receive-pack head as `bytes` holds. A convenience
+ * for a buffered prefix; streaming proxies should use
+ * `makeReceivePackHeadParser` and feed chunks as they arrive.
+ */
+declare const parseReceivePackHead: (bytes: Uint8Array, limits?: ReceivePackLimits) => ReceivePackParse;
+interface PushPolicy {
+  /** The project's default branch name, refreshed from GitLab by project ID. */
+  readonly defaultBranch: string;
+  /** Allow pushing to the default branch. Default false. */
+  readonly allowDefaultBranch?: boolean;
+  /** Only branches with this prefix may be updated, when set. */
+  readonly branchPrefix?: string;
+  /** Label every merge request created by push option must carry. */
+  readonly requiredMergeRequestLabel: string;
+  /** Whether `merge_request.*` options are allowed at all (the `open_mr` grant). */
+  readonly allowMergeRequestOptions: boolean;
+}
+/**
+ * Returns the reason a push is denied, or undefined when it is allowed.
+ * Denies tags and other non-branch refs, deletions, the default branch, and
+ * any push option outside the merge request allow-list. GitLab still applies
+ * its own branch protection afterwards.
+ */
+declare const evaluatePush: (head: ReceivePackHead, policy: PushPolicy) => string | undefined;
+//#endregion
+//#region src/bond/attribution.d.ts
+interface CommitIdentity {
+  readonly name: string;
+  readonly email: string;
+}
+/** The commit author for a GitLab user: their name and `commit_email`. */
+declare const commitAuthor: (user: {
+  readonly name: string;
+  readonly username: string;
+  readonly commitEmail?: string;
+}) => CommitIdentity;
+/** `Assisted-by: <app> <session URL>`, added to every commit. */
+declare const assistedByTrailer: (appName: string, sessionUrl: string) => string;
+/** `Co-authored-by` for a participant or, with the app principal, the requester. */
+declare const coAuthoredByTrailer: (who: CommitIdentity) => string;
+/** Description footer for merge requests and comments. */
+declare const mergeRequestFooter: (input: {
+  readonly appName: string;
+  readonly sessionUrl: string;
+  /** Username of the requesting user; set when the app principal authors. */
+  readonly requestedBy?: string;
+}) => string;
+/** `git push -o` options that create a labelled merge request. */
+declare const mergeRequestPushOptions: (input: {
+  readonly target: string;
+  readonly title: string;
+  readonly description: string;
+  readonly label: string;
+}) => readonly string[];
+//#endregion
+//#region src/bond/provider.d.ts
+interface GitLabBondProviderOptions {
+  readonly fetch?: Fetch;
+  readonly clock?: () => string;
+  /** Resolves `oauth.clientSecret` references. Omit for public clients. */
+  readonly resolveSecret?: (ref: SecretRef) => Effect.Effect<string, unknown>;
+}
+/**
+ * Bond's GitLab provider. A configured `oauth.clientSecret` requires
+ * `resolveSecret`; the provider never silently degrades to a public client. GitLab has no delegation marker, so user-principal
+ * writes need the ProviderApp's `allowUserPrincipalOutput`. The app principal
+ * is a registered bot credential stored on the Installation; GitLab 17.1
+ * cannot rotate it from the bot itself, so an administrator replaces it.
+ */
+declare const makeGitLabBondProvider: (options?: GitLabBondProviderOptions) => BondProvider;
+//#endregion
+export { type AuthorizationUrlInput, type CommitIdentity, type Fetch, type GitLabBondProviderOptions, type GitLabInstance, type GitLabOperation, type GitLabRequestClass, type GitLabTokenInfo, type GitLabUser, type OAuthClient, type Pkce, type ProjectRef, type PushPolicy, type ReceivePackCommand, type ReceivePackHead, type ReceivePackHeadParser, type ReceivePackLimits, type ReceivePackParse, type TokenPolicy, type TokenProblem, ZERO_OID, assistedByTrailer, authorizationUrl, canonicalOrigin, classifyGitLabRequest, coAuthoredByTrailer, commitAuthor, createPkce, discoverInstance, evaluatePush, exchangeCode, isValidRefName, makeGitLabBondProvider, makeReceivePackHeadParser, mergeRequestBodyProblem, mergeRequestFooter, mergeRequestPushOptions, parseReceivePackHead, readTokenInfo, readUser, refreshAccessToken, revokeSelfToken, revokeToken, tokenExpiryInstant, validateBotCredential, validatePersonalAccessToken };
+//# sourceMappingURL=index.d.ts.map