@pierre/storage 1.2.1 → 1.3.2

package/package.json

@@ -1,45 +1,45 @@
 {
-	"name": "@pierre/storage",
-	"version": "1.2.1",
-	"description": "Pierre Git Storage SDK",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/pierrecomputer/sdk"
-	},
-	"license": "MIT",
-	"type": "module",
-	"main": "./dist/index.cjs",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js",
-			"require": "./dist/index.cjs",
-			"default": "./dist/index.js"
-		}
-	},
-	"files": [
-		"dist",
-		"src"
-	],
-	"scripts": {
-		"build": "tsup",
-		"dev": "tsup --watch",
-		"prepublishOnly": "pnpm build"
-	},
-	"dependencies": {
-		"jose": "^5.10.0",
-		"snakecase-keys": "^9.0.2",
-		"zod": "^3.23.8"
-	},
-	"devDependencies": {
-		"@types/node": "^22.0.0",
-		"tsup": "8.5.0",
-		"typescript": "5.8.3",
-		"vitest": "3.2.4"
-	},
-	"publishConfig": {
-		"access": "public"
-	}
+  "name": "@pierre/storage",
+  "version": "1.3.2",
+  "description": "Pierre Git Storage SDK",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pierrecomputer/sdk"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "pnpm build"
+  },
+  "dependencies": {
+    "jose": "^5.10.0",
+    "snakecase-keys": "^9.0.2",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "8.5.0",
+    "typescript": "5.8.3",
+    "vitest": "3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/src/index.ts

@@ -44,8 +44,10 @@ import type {
   CreateBranchResult,
   CreateCommitFromDiffOptions,
   CreateCommitOptions,
+  CreateGitCredentialOptions,
   CreateNoteOptions,
   CreateRepoOptions,
+  DeleteGitCredentialOptions,
   DeleteNoteOptions,
   DeleteRepoOptions,
   DeleteRepoResult,
@@ -54,6 +56,7 @@ import type {
   FileDiff,
   FilteredFile,
   FindOneOptions,
+  GenericGitBaseRepo,
   GetBranchDiffOptions,
   GetBranchDiffResponse,
   GetBranchDiffResult,
@@ -64,6 +67,8 @@ import type {
   GetNoteOptions,
   GetNoteResult,
   GetRemoteURLOptions,
+  GitCredential,
+  GitHubBaseRepo,
   GitStorageOptions,
   GrepFileMatch,
   GrepLine,
@@ -96,6 +101,7 @@ import type {
   Repo,
   RestoreCommitOptions,
   RestoreCommitResult,
+  UpdateGitCredentialOptions,
   ValidAPIVersion,
 } from './types';
 
@@ -635,6 +641,15 @@ class RepoImpl implements Repo {
     return url.toString();
   }
 
+  async getImportRemoteURL(urlOptions?: GetRemoteURLOptions): Promise<string> {
+    const url = new URL(
+      `https://${this.options.storageBaseUrl}/${this.id}+import.git`
+    );
+    url.username = `t`;
+    url.password = await this.generateJWT(this.id, urlOptions);
+    return url.toString();
+  }
+
   async getFileStream(options: GetFileOptions): Promise<Response> {
     const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
     const jwt = await this.generateJWT(this.id, {
@@ -1428,11 +1443,16 @@ export class GitStorage {
           ...(baseRepo.sha ? { sha: baseRepo.sha } : {}),
         };
       } else {
+        // Sync base repo: GitHub or generic git provider (gitlab, bitbucket, etc.)
+        const syncRepo = baseRepo as GitHubBaseRepo | GenericGitBaseRepo;
+        const { provider: _p, ...restSnakecased } = snakecaseKeys(
+          baseRepo as unknown as Record<string, unknown>
+        ) as Record<string, unknown>;
         baseRepoOptions = {
-          provider: 'github',
-          ...snakecaseKeys(baseRepo as unknown as Record<string, unknown>),
+          provider: syncRepo.provider ?? 'github',
+          ...restSnakecased,
         };
-        resolvedDefaultBranch = baseRepo.defaultBranch;
+        resolvedDefaultBranch = syncRepo.defaultBranch;
       }
     }
 
@@ -1581,6 +1601,96 @@ export class GitStorage {
     };
   }
 
+  /**
+   * Create a generic git credential for a repository.
+   * Used to authenticate sync operations for non-GitHub providers (GitLab, Bitbucket, etc.)
+   */
+  async createGitCredential(
+    options: CreateGitCredentialOptions
+  ): Promise<GitCredential> {
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT(options.repoId, {
+      permissions: ['repo:write'],
+      ttl,
+    });
+
+    const body: Record<string, unknown> = {
+      repo_id: options.repoId,
+      password: options.password,
+    };
+    if (options.username !== undefined) {
+      body.username = options.username;
+    }
+
+    const resp = await this.api.post(
+      { path: 'repos/git-credentials', body },
+      jwt,
+      { allowedStatus: [409] }
+    );
+    if (resp.status === 409) {
+      throw new Error('A credential already exists for this repository');
+    }
+
+    const data = (await resp.json()) as { id: string };
+    return { id: data.id };
+  }
+
+  /**
+   * Update an existing generic git credential.
+   */
+  async updateGitCredential(
+    options: UpdateGitCredentialOptions
+  ): Promise<GitCredential> {
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT('org', {
+      permissions: ['repo:write'],
+      ttl,
+    });
+
+    const body: Record<string, unknown> = {
+      id: options.id,
+      password: options.password,
+    };
+    if (options.username !== undefined) {
+      body.username = options.username;
+    }
+
+    const resp = await this.api.put(
+      { path: 'repos/git-credentials', body },
+      jwt,
+      { allowedStatus: [404] }
+    );
+    if (resp.status === 404) {
+      throw new Error('Credential not found');
+    }
+
+    const data = (await resp.json()) as { id: string; created_at?: string };
+    return {
+      id: data.id,
+      ...(data.created_at ? { createdAt: data.created_at } : {}),
+    };
+  }
+
+  /**
+   * Delete a generic git credential.
+   */
+  async deleteGitCredential(options: DeleteGitCredentialOptions): Promise<void> {
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT('org', {
+      permissions: ['repo:write'],
+      ttl,
+    });
+
+    const resp = await this.api.delete(
+      { path: 'repos/git-credentials', body: { id: options.id } },
+      jwt,
+      { allowedStatus: [404] }
+    );
+    if (resp.status === 404) {
+      throw new Error('Credential not found');
+    }
+  }
+
   /**
    * Get the current configuration
    * @returns The client configuration

package/src/types.ts

@@ -48,6 +48,7 @@ export interface Repo {
   createdAt: string;
   getRemoteURL(options?: GetRemoteURLOptions): Promise<string>;
   getEphemeralRemoteURL(options?: GetRemoteURLOptions): Promise<string>;
+  getImportRemoteURL(options?: GetRemoteURLOptions): Promise<string>;
 
   getFileStream(options: GetFileOptions): Promise<Response>;
   getArchiveStream(options?: ArchiveOptions): Promise<Response>;
@@ -96,7 +97,14 @@ export interface RepoOptions {
   createdAt?: string;
 }
 
-export type SupportedRepoProvider = 'github';
+export type SupportedRepoProvider =
+  | 'github'
+  | 'gitlab'
+  | 'bitbucket'
+  | 'gitea'
+  | 'forgejo'
+  | 'codeberg'
+  | 'sr.ht';
 
 export interface PublicGitHubBaseRepoAuth {
   /**
@@ -109,20 +117,59 @@ export interface GitHubBaseRepo {
   /**
    * @default github
    */
-  provider?: SupportedRepoProvider;
+  provider?: 'github';
   owner: string;
   name: string;
   defaultBranch?: string;
   auth?: PublicGitHubBaseRepoAuth;
 }
 
+export interface GenericGitBaseRepo {
+  /**
+   * The git host provider. Must be one of the supported generic git providers.
+   */
+  provider: Exclude<SupportedRepoProvider, 'github'>;
+  owner: string;
+  name: string;
+  defaultBranch?: string;
+  /**
+   * Bare hostname for self-hosted instances (e.g. "gitlab.example.com").
+   * Falls back to the provider's default host when omitted.
+   */
+  upstreamHost?: string;
+}
+
 export interface ForkBaseRepo {
   id: string;
   ref?: string;
   sha?: string;
 }
 
-export type BaseRepo = GitHubBaseRepo | ForkBaseRepo;
+export type BaseRepo = GitHubBaseRepo | ForkBaseRepo | GenericGitBaseRepo;
+
+export interface CreateGitCredentialOptions {
+  repoId: string;
+  username?: string;
+  password: string;
+  ttl?: number;
+}
+
+export interface UpdateGitCredentialOptions {
+  id: string;
+  username?: string;
+  password: string;
+  ttl?: number;
+}
+
+export interface DeleteGitCredentialOptions {
+  id: string;
+  ttl?: number;
+}
+
+export interface GitCredential {
+  id: string;
+  createdAt?: string;
+}
 
 export interface ListReposOptions extends GitStorageInvocationOptions {
   cursor?: string;