feat: expose timezone offset field on Signature type (#214)

docs/reference/Blame/Methods/getHunkByIndex.md

@@ -48,6 +48,11 @@ class Blame {
             <br>
             <p class="param-description">Name on the signature.</p>
           </li>
+          <li class="param-li">
+            <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+            <br>
+            <p class="param-description">Timezone offset, in minutes</p>
+          </li>
           <li class="param-li">
             <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
             <br>
@@ -90,6 +95,11 @@ class Blame {
             <br>
             <p class="param-description">Name on the signature.</p>
           </li>
+          <li class="param-li">
+            <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+            <br>
+            <p class="param-description">Timezone offset, in minutes</p>
+          </li>
           <li class="param-li">
             <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
             <br>

docs/reference/Blame/Methods/getHunkByLine.md

@@ -48,6 +48,11 @@ class Blame {
             <br>
             <p class="param-description">Name on the signature.</p>
           </li>
+          <li class="param-li">
+            <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+            <br>
+            <p class="param-description">Timezone offset, in minutes</p>
+          </li>
           <li class="param-li">
             <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
             <br>
@@ -90,6 +95,11 @@ class Blame {
             <br>
             <p class="param-description">Name on the signature.</p>
           </li>
+          <li class="param-li">
+            <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+            <br>
+            <p class="param-description">Timezone offset, in minutes</p>
+          </li>
           <li class="param-li">
             <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
             <br>

docs/reference/Commit/Methods/author.md

@@ -28,6 +28,11 @@ class Commit {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Commit/Methods/authorWithMailmap.md

@@ -38,6 +38,11 @@ class Commit {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Commit/Methods/committer.md

@@ -28,6 +28,11 @@ class Commit {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Commit/Methods/committerWithMailmap.md

@@ -38,6 +38,11 @@ class Commit {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Mailmap/Methods/resolveSignature.md

@@ -68,6 +68,11 @@ class Mailmap {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Note/Methods/author.md

@@ -28,6 +28,11 @@ class Note {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Note/Methods/committer.md

@@ -28,6 +28,11 @@ class Note {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Reflog/Methods/append.md

@@ -33,6 +33,11 @@ class Reflog {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/ReflogEntry/Methods/committer.md

@@ -28,6 +28,11 @@ class ReflogEntry {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Signature/createSignature.md

@@ -62,6 +62,11 @@ function createSignature(
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

docs/reference/Tag/Methods/tagger.md

@@ -28,6 +28,11 @@ class Tag {
         <br>
         <p class="param-description">Name on the signature.</p>
       </li>
+      <li class="param-li">
+        <span class="param-name">offset</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
+        <br>
+        <p class="param-description">Timezone offset, in minutes</p>
+      </li>
       <li class="param-li">
         <span class="param-name">timestamp</span><span class="param-required">required</span>&nbsp;·&nbsp;<span class="param-type">number</span>
         <br>

index.d.ts

@@ -8956,6 +8956,8 @@ export interface Signature {
   email: string
   /** Time in seconds, from epoch */
   timestamp: number
+  /** Timezone offset, in minutes */
+  offset: number
 }
 
 export interface SignaturePayload {

src/signature.rs

@@ -12,6 +12,8 @@ pub struct Signature {
   pub email: String,
   /// Time in seconds, from epoch
   pub timestamp: i64,
+  /// Timezone offset, in minutes
+  pub offset: i32,
 }
 
 impl<'a> TryFrom<git2::Signature<'a>> for Signature {
@@ -21,7 +23,13 @@ impl<'a> TryFrom<git2::Signature<'a>> for Signature {
     let name = std::str::from_utf8(value.name_bytes())?.to_string();
     let email = std::str::from_utf8(value.email_bytes())?.to_string();
     let timestamp = value.when().seconds();
-    Ok(Self { name, email, timestamp })
+    let offset = value.when().offset_minutes();
+    Ok(Self {
+      name,
+      email,
+      timestamp,
+      offset,
+    })
   }
 }
 

tests/rebase.spec.ts

@@ -1,14 +1,24 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import { describe, expect, it } from 'vitest';
-import { openRepository, type RebaseOperation } from '../index';
+import { openRepository, type RebaseOperation, type Signature, type SignaturePayload } from '../index';
 import { useFixture } from './fixtures';
 
 describe('rebase', () => {
   it('rebase (no-conflict): feature onto main', async () => {
     const p = await useFixture('empty');
     const repo = await openRepository(p);
-    const sig = { name: 'Test User', email: 'test@example.com' };
+    const sig = {
+      name: 'Test User',
+      email: 'test@example.com',
+      timeOptions: { timestamp: 1678886400, offset: 0 },
+    } satisfies SignaturePayload;
+    const expectedCommitter: Signature = {
+      name: sig.name,
+      email: sig.email,
+      timestamp: sig.timeOptions.timestamp,
+      offset: sig.timeOptions.offset,
+    };
 
     // initial commit (o0)
     let index = repo.index();
@@ -79,6 +89,7 @@ describe('rebase', () => {
     const featureAfter = repo.getReference('refs/heads/feature').target()!;
     const featureCommit = repo.getCommit(featureAfter);
     expect(featureCommit.message()).toBe('feat-1');
+    expect(featureCommit.committer()).toEqual(expectedCommitter);
     expect(repo.getMergeBase(featureAfter, o1)).toEqual(o1);
 
     const mainStatus = repo.getStatusFile('main.txt');