@pierre/storage 0.2.2 → 0.3.0

package/README.md

@@ -76,6 +76,26 @@ const readOnlyUrl = await repo.getRemoteURL({
 // - 'repo:write' - Create a repository
 ```
 
+#### Ephemeral Branches
+
+For working with ephemeral branches (temporary branches isolated from the main repository), use
+`getEphemeralRemote()`:
+
+```typescript
+// Get ephemeral namespace remote URL
+const ephemeralUrl = await repo.getEphemeralRemoteURL();
+// Returns: https://t:JWT@your-name.code.storage/repo-id+ephemeral.git
+
+// Configure separate remotes for default and ephemeral branches
+console.log(`Run: git remote add origin ${await repo.getRemoteURL()}`);
+console.log(`Run: git remote add ephemeral ${await repo.getEphemeralRemoteURL()}`);
+
+// Push ephemeral branch
+// git push ephemeral feature-branch
+
+// The ephemeral remote supports all the same options and permission as regular remotes
+```
+
 ### Working with Repository Content
 
 Once you have a repository instance, you can perform various Git operations:
@@ -290,6 +310,7 @@ interface FindOneOptions {
 interface Repo {
   id: string;
   getRemoteURL(options?: GetRemoteURLOptions): Promise<string>;
+  getEphemeralRemoteURL(options?: GetRemoteURLOptions): Promise<string>;
 
   getFileStream(options: GetFileOptions): Promise<Response>;
   listFiles(options?: ListFilesOptions): Promise<ListFilesResult>;
@@ -387,6 +408,8 @@ interface GetBranchDiffOptions {
   branch: string;
   base?: string; // Defaults to 'main'
   ttl?: number;
+  ephemeral?: boolean;
+  ephemeralBase?: boolean;
 }
 
 interface GetCommitDiffOptions {

package/dist/index.cjs

@@ -448,6 +448,17 @@ function concatChunks(a, b) {
   return merged;
 }
 
+// package.json
+var package_default = {
+  version: "0.3.0"};
+
+// src/version.ts
+var PACKAGE_NAME = "code-storage-sdk";
+var PACKAGE_VERSION = package_default.version;
+function getUserAgent() {
+  return `${PACKAGE_NAME}/${PACKAGE_VERSION}`;
+}
+
 // src/commit.ts
 var DEFAULT_TTL_SECONDS = 60 * 60;
 var HEADS_REF_PREFIX = "refs/heads/";
@@ -620,7 +631,8 @@ var FetchCommitTransport = class {
       headers: {
         Authorization: `Bearer ${request.authorization}`,
         "Content-Type": "application/x-ndjson",
-        Accept: "application/json"
+        Accept: "application/json",
+        "Code-Storage-Agent": getUserAgent()
       },
       body,
       signal: request.signal
@@ -850,7 +862,8 @@ var FetchDiffCommitTransport = class {
       headers: {
         Authorization: `Bearer ${request.authorization}`,
         "Content-Type": "application/x-ndjson",
-        Accept: "application/json"
+        Accept: "application/json",
+        "Code-Storage-Agent": getUserAgent()
       },
       body,
       signal: request.signal
@@ -987,7 +1000,8 @@ var ApiFetcher = class {
       method,
       headers: {
         Authorization: `Bearer ${jwt}`,
-        "Content-Type": "application/json"
+        "Content-Type": "application/json",
+        "Code-Storage-Agent": getUserAgent()
       }
     };
     if (method !== "GET" && typeof path !== "string" && path.body) {
@@ -1283,8 +1297,8 @@ function isRecord(value) {
 }
 
 // src/index.ts
-var API_BASE_URL = "https://api.code.storage";
-var STORAGE_BASE_URL = "code.storage";
+var API_BASE_URL = "https://api.{{org}}.code.storage";
+var STORAGE_BASE_URL = "{{org}}.code.storage";
 var API_VERSION = 1;
 var apiInstanceMap = /* @__PURE__ */ new Map();
 var DEFAULT_TOKEN_TTL_SECONDS = 60 * 60;
@@ -1511,14 +1525,19 @@ var RepoImpl = class {
     this.options = options;
     this.generateJWT = generateJWT;
     this.api = getApiInstance(
-      this.options.apiBaseUrl ?? API_BASE_URL,
+      this.options.apiBaseUrl ?? GitStorage.getDefaultAPIBaseUrl(options.name),
       this.options.apiVersion ?? API_VERSION
     );
   }
   api;
   async getRemoteURL(urlOptions) {
-    const storageBaseUrl = this.options.storageBaseUrl ?? STORAGE_BASE_URL;
-    const url = new URL(`https://${this.options.name}.${storageBaseUrl}/${this.id}.git`);
+    const url = new URL(`https://${this.options.storageBaseUrl}/${this.id}.git`);
+    url.username = `t`;
+    url.password = await this.generateJWT(this.id, urlOptions);
+    return url.toString();
+  }
+  async getEphemeralRemoteURL(urlOptions) {
+    const url = new URL(`https://${this.options.storageBaseUrl}/${this.id}+ephemeral.git`);
     url.username = `t`;
     url.password = await this.generateJWT(this.id, urlOptions);
     return url.toString();
@@ -1538,6 +1557,9 @@ var RepoImpl = class {
     if (typeof options.ephemeral === "boolean") {
       params.ephemeral = String(options.ephemeral);
     }
+    if (typeof options.ephemeralBase === "boolean") {
+      params.ephemeral_base = String(options.ephemeralBase);
+    }
     return this.api.get({ path: "repos/file", params }, jwt);
   }
   async listFiles(options) {
@@ -1623,6 +1645,12 @@ var RepoImpl = class {
     if (options.base) {
       params.base = options.base;
     }
+    if (typeof options.ephemeral === "boolean") {
+      params.ephemeral = String(options.ephemeral);
+    }
+    if (typeof options.ephemeralBase === "boolean") {
+      params.ephemeral_base = String(options.ephemeralBase);
+    }
     const response = await this.api.get({ path: "repos/branches/diff", params }, jwt);
     const raw = branchDiffResponseSchema.parse(await response.json());
     return transformBranchDiffResult(raw);
@@ -1636,6 +1664,9 @@ var RepoImpl = class {
     const params = {
       sha: options.sha
     };
+    if (options.baseSha) {
+      params.baseSha = options.baseSha;
+    }
     const response = await this.api.get({ path: "repos/diff", params }, jwt);
     const raw = commitDiffResponseSchema.parse(await response.json());
     return transformCommitDiffResult(raw);
@@ -1755,7 +1786,7 @@ var RepoImpl = class {
   }
   createCommit(options) {
     const version = this.options.apiVersion ?? API_VERSION;
-    const baseUrl = this.options.apiBaseUrl ?? API_BASE_URL;
+    const baseUrl = this.options.apiBaseUrl ?? GitStorage.getDefaultAPIBaseUrl(this.options.name);
     const transport = new FetchCommitTransport({ baseUrl, version });
     const ttl = resolveCommitTtlSeconds(options);
     const builderOptions = {
@@ -1774,7 +1805,7 @@ var RepoImpl = class {
   }
   async createCommitFromDiff(options) {
     const version = this.options.apiVersion ?? API_VERSION;
-    const baseUrl = this.options.apiBaseUrl ?? API_BASE_URL;
+    const baseUrl = this.options.apiBaseUrl ?? GitStorage.getDefaultAPIBaseUrl(this.options.name);
     const transport = new FetchDiffCommitTransport({ baseUrl, version });
     const ttl = resolveCommitTtlSeconds(options);
     const requestOptions = {
@@ -1793,7 +1824,6 @@ var RepoImpl = class {
   }
 };
 var GitStorage = class _GitStorage {
-  static overrides = {};
   options;
   api;
   constructor(options) {
@@ -1808,10 +1838,10 @@ var GitStorage = class _GitStorage {
     if (typeof options.key !== "string" || options.key.trim() === "") {
       throw new Error("GitStorage key must be a non-empty string.");
     }
-    const resolvedApiBaseUrl = options.apiBaseUrl ?? _GitStorage.overrides.apiBaseUrl ?? API_BASE_URL;
-    const resolvedApiVersion = options.apiVersion ?? _GitStorage.overrides.apiVersion ?? API_VERSION;
-    const resolvedStorageBaseUrl = options.storageBaseUrl ?? _GitStorage.overrides.storageBaseUrl ?? STORAGE_BASE_URL;
-    const resolvedDefaultTtl = options.defaultTTL ?? _GitStorage.overrides.defaultTTL;
+    const resolvedApiBaseUrl = options.apiBaseUrl ?? _GitStorage.getDefaultAPIBaseUrl(options.name);
+    const resolvedApiVersion = options.apiVersion ?? API_VERSION;
+    const resolvedStorageBaseUrl = options.storageBaseUrl ?? _GitStorage.getDefaultStorageBaseUrl(options.name);
+    const resolvedDefaultTtl = options.defaultTTL;
     this.api = getApiInstance(resolvedApiBaseUrl, resolvedApiVersion);
     this.options = {
       key: options.key,
@@ -1822,8 +1852,11 @@ var GitStorage = class _GitStorage {
       defaultTTL: resolvedDefaultTtl
     };
   }
-  static override(options) {
-    this.overrides = Object.assign({}, this.overrides, options);
+  static getDefaultAPIBaseUrl(name) {
+    return API_BASE_URL.replace("{{org}}", name);
+  }
+  static getDefaultStorageBaseUrl(name) {
+    return STORAGE_BASE_URL.replace("{{org}}", name);
   }
   /**
    * Create a new repository
@@ -1903,6 +1936,7 @@ function createClient(options) {
 }
 
 exports.ApiError = ApiError;
+exports.CodeStorage = GitStorage;
 exports.GitStorage = GitStorage;
 exports.RefUpdateError = RefUpdateError;
 exports.createClient = createClient;