@pierre/storage 1.3.2 → 1.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pierre/storage",
-  "version": "1.3.2",
+  "version": "1.4.1",
   "description": "Pierre Git Storage SDK",
   "repository": {
     "type": "git",

package/src/index.ts

@@ -19,6 +19,8 @@ import {
   branchDiffResponseSchema,
   commitDiffResponseSchema,
   createBranchResponseSchema,
+  createTagResponseSchema,
+  deleteTagResponseSchema,
   errorEnvelopeSchema,
   grepResponseSchema,
   listBranchesResponseSchema,
@@ -26,6 +28,7 @@ import {
   listFilesResponseSchema,
   listFilesWithMetadataResponseSchema,
   listReposResponseSchema,
+  listTagsResponseSchema,
   noteReadResponseSchema,
   noteWriteResponseSchema,
   restoreCommitAckSchema,
@@ -44,9 +47,15 @@ import type {
   CreateBranchResult,
   CreateCommitFromDiffOptions,
   CreateCommitOptions,
+  CreateTagOptions,
+  CreateTagResponse,
+  CreateTagResult,
   CreateGitCredentialOptions,
   CreateNoteOptions,
   CreateRepoOptions,
+  DeleteTagOptions,
+  DeleteTagResponse,
+  DeleteTagResult,
   DeleteGitCredentialOptions,
   DeleteNoteOptions,
   DeleteRepoOptions,
@@ -88,6 +97,9 @@ import type {
   ListReposOptions,
   ListReposResponse,
   ListReposResult,
+  ListTagsOptions,
+  ListTagsResponse,
+  ListTagsResult,
   NoteWriteResult,
   PullUpstreamOptions,
   RawBranchInfo,
@@ -96,11 +108,13 @@ import type {
   RawFileWithMetadata,
   RawFileDiff,
   RawFilteredFile,
+  RawTagInfo,
   RefUpdate,
   RepoOptions,
   Repo,
   RestoreCommitOptions,
   RestoreCommitResult,
+  TagInfo,
   UpdateGitCredentialOptions,
   ValidAPIVersion,
 } from './types';
@@ -444,6 +458,37 @@ function transformCreateBranchResult(
   };
 }
 
+function transformTagInfo(raw: RawTagInfo): TagInfo {
+  return {
+    cursor: raw.cursor,
+    name: raw.name,
+    sha: raw.sha,
+  };
+}
+
+function transformListTagsResult(raw: ListTagsResponse): ListTagsResult {
+  return {
+    tags: raw.tags.map(transformTagInfo),
+    nextCursor: raw.next_cursor ?? undefined,
+    hasMore: raw.has_more,
+  };
+}
+
+function transformCreateTagResult(raw: CreateTagResponse): CreateTagResult {
+  return {
+    name: raw.name,
+    sha: raw.sha,
+    message: raw.message,
+  };
+}
+
+function transformDeleteTagResult(raw: DeleteTagResponse): DeleteTagResult {
+  return {
+    name: raw.name,
+    message: raw.message,
+  };
+}
+
 function transformListReposResult(raw: ListReposResponse): ListReposResult {
   return {
     repos: raw.repos.map((repo) => ({
@@ -799,6 +844,36 @@ class RepoImpl implements Repo {
     });
   }
 
+  async listTags(options?: ListTagsOptions): Promise<ListTagsResult> {
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT(this.id, {
+      permissions: ['git:read'],
+      ttl,
+    });
+
+    const cursor = options?.cursor;
+    const limit = options?.limit;
+
+    let params: Record<string, string> | undefined;
+
+    if (typeof cursor === 'string' || typeof limit === 'number') {
+      params = {};
+      if (typeof cursor === 'string') {
+        params.cursor = cursor;
+      }
+      if (typeof limit === 'number') {
+        params.limit = limit.toString();
+      }
+    }
+
+    const response = await this.api.get({ path: 'repos/tags', params }, jwt);
+    const raw = listTagsResponseSchema.parse(await response.json());
+    return transformListTagsResult({
+      ...raw,
+      next_cursor: raw.next_cursor ?? undefined,
+    });
+  }
+
   async listCommits(options?: ListCommitsOptions): Promise<ListCommitsResult> {
     const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
     const jwt = await this.generateJWT(this.id, {
@@ -1215,6 +1290,57 @@ class RepoImpl implements Repo {
     return transformCreateBranchResult(raw);
   }
 
+  async createTag(options: CreateTagOptions): Promise<CreateTagResult> {
+    const name = options?.name?.trim();
+    if (!name) {
+      throw new Error('createTag name is required');
+    }
+    if (name.startsWith('refs/')) {
+      throw new Error('createTag name must not start with refs/');
+    }
+
+    const target = options?.target?.trim();
+    if (!target) {
+      throw new Error('createTag target is required');
+    }
+
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT(this.id, {
+      permissions: ['git:write'],
+      ttl,
+    });
+
+    const response = await this.api.post(
+      { path: 'repos/tags', body: { name, target } },
+      jwt
+    );
+    const raw = createTagResponseSchema.parse(await response.json());
+    return transformCreateTagResult(raw);
+  }
+
+  async deleteTag(options: DeleteTagOptions): Promise<DeleteTagResult> {
+    const name = options?.name?.trim();
+    if (!name) {
+      throw new Error('deleteTag name is required');
+    }
+    if (name.startsWith('refs/')) {
+      throw new Error('deleteTag name must not start with refs/');
+    }
+
+    const ttl = resolveInvocationTtlSeconds(options, DEFAULT_TOKEN_TTL_SECONDS);
+    const jwt = await this.generateJWT(this.id, {
+      permissions: ['git:read', 'git:write'],
+      ttl,
+    });
+
+    const response = await this.api.delete(
+      { path: 'repos/tags', body: { name } },
+      jwt
+    );
+    const raw = deleteTagResponseSchema.parse(await response.json());
+    return transformDeleteTagResult(raw);
+  }
+
   async restoreCommit(
     options: RestoreCommitOptions
   ): Promise<RestoreCommitResult> {
@@ -1723,6 +1849,7 @@ export class GitStorage {
       scopes: permissions,
       iat: now,
       exp: now + ttl,
+      ...(options?.ops && options.ops.length > 0 ? { ops: options.ops } : {}),
     };
 
     // Sign the JWT with the key as the secret

package/src/schemas.ts

@@ -141,6 +141,29 @@ export const createBranchResponseSchema = z.object({
   commit_sha: z.string().nullable().optional(),
 });
 
+export const tagInfoSchema = z.object({
+  cursor: z.string(),
+  name: z.string(),
+  sha: z.string(),
+});
+
+export const listTagsResponseSchema = z.object({
+  tags: z.array(tagInfoSchema),
+  next_cursor: z.string().nullable().optional(),
+  has_more: z.boolean(),
+});
+
+export const createTagResponseSchema = z.object({
+  name: z.string(),
+  sha: z.string(),
+  message: z.string(),
+});
+
+export const deleteTagResponseSchema = z.object({
+  name: z.string(),
+  message: z.string(),
+});
+
 export const refUpdateResultSchema = z.object({
   branch: z.string(),
   old_sha: z.string(),
@@ -244,6 +267,10 @@ export type GetCommitDiffResponseRaw = z.infer<typeof commitDiffResponseSchema>;
 export type CreateBranchResponseRaw = z.infer<
   typeof createBranchResponseSchema
 >;
+export type RawTagInfo = z.infer<typeof tagInfoSchema>;
+export type ListTagsResponseRaw = z.infer<typeof listTagsResponseSchema>;
+export type CreateTagResponseRaw = z.infer<typeof createTagResponseSchema>;
+export type DeleteTagResponseRaw = z.infer<typeof deleteTagResponseSchema>;
 export type CommitPackAckRaw = z.infer<typeof commitPackAckSchema>;
 export type RestoreCommitAckRaw = z.infer<typeof restoreCommitAckSchema>;
 export type GrepResponseRaw = z.infer<typeof grepResponseSchema>;

package/src/types.ts

@@ -3,6 +3,8 @@
  */
 import type {
   CreateBranchResponseRaw,
+  CreateTagResponseRaw,
+  DeleteTagResponseRaw,
   GetBranchDiffResponseRaw,
   GetCommitDiffResponseRaw,
   ListBranchesResponseRaw,
@@ -10,6 +12,7 @@ import type {
   ListFilesResponseRaw,
   ListFilesWithMetadataResponseRaw,
   ListReposResponseRaw,
+  ListTagsResponseRaw,
   NoteReadResponseRaw,
   NoteWriteResponseRaw,
   RawBranchInfo as SchemaRawBranchInfo,
@@ -20,6 +23,7 @@ import type {
   RawFilteredFile as SchemaRawFilteredFile,
   RawRepoBaseInfo as SchemaRawRepoBaseInfo,
   RawRepoInfo as SchemaRawRepoInfo,
+  RawTagInfo as SchemaRawTagInfo,
 } from './schemas';
 
 export interface OverrideableGitStorageOptions {
@@ -37,9 +41,18 @@ export interface GitStorageOptions extends OverrideableGitStorageOptions {
 
 export type ValidAPIVersion = 1;
 
+/** A policy operation included in the JWT. */
+export type Op = string;
+
+export const OP_NO_FORCE_PUSH: Op = 'no-force-push';
+
+/** A list of policy operations. */
+export type Ops = Op[];
+
 export interface GetRemoteURLOptions {
   permissions?: ('git:write' | 'git:read' | 'repo:write' | 'org:read')[];
   ttl?: number;
+  ops?: Ops;
 }
 
 export interface Repo {
@@ -57,7 +70,10 @@ export interface Repo {
     options?: ListFilesWithMetadataOptions
   ): Promise<ListFilesWithMetadataResult>;
   listBranches(options?: ListBranchesOptions): Promise<ListBranchesResult>;
+  listTags(options?: ListTagsOptions): Promise<ListTagsResult>;
   listCommits(options?: ListCommitsOptions): Promise<ListCommitsResult>;
+  createTag(options: CreateTagOptions): Promise<CreateTagResult>;
+  deleteTag(options: DeleteTagOptions): Promise<DeleteTagResult>;
   getNote(options: GetNoteOptions): Promise<GetNoteResult>;
   createNote(options: CreateNoteOptions): Promise<NoteWriteResult>;
   appendNote(options: AppendNoteOptions): Promise<NoteWriteResult>;
@@ -321,6 +337,51 @@ export interface CreateBranchResult {
   commitSha?: string;
 }
 
+export interface ListTagsOptions extends GitStorageInvocationOptions {
+  cursor?: string;
+  limit?: number;
+}
+
+export type RawTagInfo = SchemaRawTagInfo;
+
+export interface TagInfo {
+  cursor: string;
+  name: string;
+  sha: string;
+}
+
+export type ListTagsResponse = ListTagsResponseRaw;
+
+export interface ListTagsResult {
+  tags: TagInfo[];
+  nextCursor?: string;
+  hasMore: boolean;
+}
+
+export interface CreateTagOptions extends GitStorageInvocationOptions {
+  name: string;
+  target: string;
+}
+
+export type CreateTagResponse = CreateTagResponseRaw;
+
+export interface CreateTagResult {
+  name: string;
+  sha: string;
+  message: string;
+}
+
+export interface DeleteTagOptions extends GitStorageInvocationOptions {
+  name: string;
+}
+
+export type DeleteTagResponse = DeleteTagResponseRaw;
+
+export interface DeleteTagResult {
+  name: string;
+  message: string;
+}
+
 // List Commits API types
 export interface ListCommitsOptions extends GitStorageInvocationOptions {
   branch?: string;