@meistrari/vault-sdk 1.3.0 → 1.4.0

package/dist/index.cjs

@@ -4,15 +4,15 @@ const schemas = require('@meistrari/vault-shared/schemas');
 const fileType = require('file-type');
 const mimeTypes = require('mime-types');
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class DataTokenAuthStrategy {
   constructor(dataToken) {
-    __publicField$1(this, "dataToken");
+    __publicField$2(this, "dataToken");
     this.dataToken = dataToken;
   }
   getHeaders() {
@@ -23,7 +23,7 @@ class DataTokenAuthStrategy {
 }
 class APIKeyAuthStrategy {
   constructor(apiKey) {
-    __publicField$1(this, "apiKey");
+    __publicField$2(this, "apiKey");
     this.apiKey = apiKey;
   }
   getHeaders() {
@@ -50,6 +50,103 @@ ${text}`, url, method, response);
   }
 }
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Permalink {
+  constructor(config, params) {
+    __publicField$1(this, "config");
+    __publicField$1(this, "id");
+    __publicField$1(this, "workspaceId");
+    __publicField$1(this, "createdAt");
+    __publicField$1(this, "createdBy");
+    __publicField$1(this, "expiresAt");
+    __publicField$1(this, "fileId");
+    this.config = config;
+    this.id = params.id;
+    this.workspaceId = params.workspaceId;
+    this.createdAt = new Date(params.createdAt);
+    this.createdBy = params.createdBy;
+    this.expiresAt = params.expiresAt ? new Date(params.expiresAt) : null;
+    this.fileId = params.fileId;
+  }
+  /**
+   * The URL for the permalink.
+   */
+  get url() {
+    return new URL(`/permalinks/${this.id}`, this.config.vaultUrl);
+  }
+  /**
+   * Get a new permalink instance from its ID.
+   *
+   * @param config - The vault config.
+   * @param id - The permalink ID.
+   * @returns The permalink.
+   */
+  static async fromId(config, id) {
+    const response = await fetch(`${config.vaultUrl}/permalinks/${id}/metadata`, {
+      headers: config.authStrategy.getHeaders()
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "GET", response);
+    }
+    const data = await response.json();
+    return new Permalink(config, data);
+  }
+  /**
+   * Create a new permalink.
+   *
+   * @param config - The vault config.
+   * @param params - The parameters for the permalink.
+   * @param params.expiresIn - Time, in seconds, the permalink will be valid for.
+   * @param params.fileId - The ID of the file to create a permalink for.
+   * @param params.workspaceId - The ID of the workspace to create a permalink for.
+   *
+   * @param options - Additional options for the request.
+   * @param options.signal - The signal to abort the request.
+   *
+   * @returns The permalink.
+   */
+  static async create(config, params, options) {
+    const { expiresIn } = params;
+    const expiresAt = expiresIn ? new Date(Date.now() + expiresIn * 1e3) : void 0;
+    const headers = config.authStrategy.getHeaders();
+    headers.append("x-compatibility-date", "2025-07-29");
+    headers.append("content-type", "application/json");
+    const body = expiresAt ? JSON.stringify({ expiresAt: expiresAt.toISOString() }) : "{}";
+    const response = await fetch(`${config.vaultUrl}/files/${params.fileId}/permalinks`, {
+      method: "POST",
+      signal: options?.signal,
+      headers,
+      body
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "POST", response);
+    }
+    const data = await response.json();
+    return new Permalink(config, data);
+  }
+  /**
+   * Delete the permalink.
+   *
+   * @param options - Additional options for the request.
+   * @param options.signal - The signal to abort the request.
+   */
+  async delete(options) {
+    const response = await fetch(`${this.config.vaultUrl}/permalinks/${this.id}`, {
+      method: "DELETE",
+      signal: options?.signal,
+      headers: this.config.authStrategy.getHeaders()
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "DELETE", response);
+    }
+  }
+}
+
 async function blobToBase64(blob) {
   const fileContent = new Uint8Array(await blob.arrayBuffer());
   let content = "";
@@ -150,10 +247,15 @@ class VaultFile {
    * @throws {FetchError} If the fetch fails
    */
   async _fetch(params) {
-    const { method, path, body, signal } = params;
-    const url = new URL(this.config.vaultUrl + path).toString();
+    const { method, path, body, signal, query } = params;
+    const url = new URL(path, this.config.vaultUrl);
     const headers = new Headers(this.headers);
     headers.set("x-compatibility-date", compatibilityDate);
+    if (query) {
+      Object.entries(query).forEach(([key, value]) => {
+        url.searchParams.set(key, value);
+      });
+    }
     const response = await wrappedFetch(url, {
       method,
       body,
@@ -178,7 +280,7 @@ class VaultFile {
   async _createFile(metadata = {}, options) {
     const response = await this._fetch({
       method: "POST",
-      path: `/v2/files`,
+      path: `files`,
       body: JSON.stringify({
         ...metadata,
         fileName: this.name,
@@ -237,7 +339,8 @@ class VaultFile {
     const { reference, config, download = false } = params;
     const { vaultUrl, authStrategy } = config;
     const id = removeVaultPrefix(reference);
-    const response = await wrappedFetch(`${vaultUrl}/v2/files/${id}`, {
+    const url = new URL(`files/${id}`, vaultUrl);
+    const response = await wrappedFetch(url, {
       method: "GET",
       headers: authStrategy.getHeaders(),
       signal: options?.signal
@@ -372,7 +475,7 @@ class VaultFile {
     }
     const response = await this._fetch({
       method: "GET",
-      path: `/v2/files/${this.id}/metadata`,
+      path: `files/${this.id}/metadata`,
       signal: options?.signal
     });
     return response;
@@ -381,6 +484,7 @@ class VaultFile {
    * Fetches a upload URL for the file.
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
+   * @param options.expiresIn - The number of seconds the upload URL will be valid for
    *
    * @returns The upload URL for the file
    * @throws {Error} If the vault service returns an invalid response
@@ -400,8 +504,9 @@ class VaultFile {
     }
     const response = await this._fetch({
       method: "PUT",
-      path: `/v2/files/${this.id}`,
-      signal: options?.signal
+      path: `files/${this.id}`,
+      signal: options?.signal,
+      ...options?.expiresIn ? { query: { expiresIn: options.expiresIn.toString() } } : {}
     }).then(schemas.GetUploadUrlResponseV2.safeParse);
     if (!response.success) {
       throw new Error(`Invalid response from vault service. ${JSON.stringify(response.error)}`);
@@ -413,6 +518,7 @@ class VaultFile {
    * Fetches a download URL for the file.
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
+   * @param options.expiresIn - The number of seconds the download URL will be valid for
    *
    * @returns The download URL for the file
    * @throws {Error} If the vault service returns an invalid response
@@ -429,8 +535,9 @@ class VaultFile {
     const id = this.id ?? this.metadata?.id ?? (this.content ? await getFileHash(this.content) : this.name);
     const response = await this._fetch({
       method: "GET",
-      path: `/v2/files/${id}`,
-      signal: options?.signal
+      path: `files/${id}`,
+      signal: options?.signal,
+      ...options?.expiresIn ? { query: { expiresIn: options.expiresIn.toString() } } : {}
     });
     this.lastDownloadUrl = { url: new URL(response.url), expiresAt: new Date(response.expiresAt) };
     return this.lastDownloadUrl.url;
@@ -501,9 +608,49 @@ class VaultFile {
     }
     await this._fetch({
       method: "DELETE",
-      path: `/v2/files/${this.id}`,
+      path: `files/${this.id}`,
+      signal: options?.signal
+    });
+  }
+  /**
+   * Creates a permalink for the file.
+   * @param params - The parameters for the permalink
+   * @param params.expiresIn - The number of seconds the permalink will be valid for
+   * @param options - The options for the request
+   * @param options.signal - The signal to abort the request
+   *
+   * @returns The permalink for the file
+   */
+  async createPermalink(params = {}, options) {
+    if (!this.id) {
+      throw new Error("File ID is not set");
+    }
+    if (!this.metadata?.workspaceId) {
+      throw new Error("Workspace ID is not set. Call populateMetadata() to populate the metadata fields.");
+    }
+    return Permalink.create(this.config, {
+      fileId: this.id,
+      workspaceId: this.metadata.workspaceId,
+      expiresIn: params.expiresIn
+    }, options);
+  }
+  /**
+   * Gets a list of the valid permalinks for the file.
+   * @param options - Additional options for the request
+   * @param options.signal - Abort signal
+   *
+   * @returns The permalinks for the file
+   */
+  async getPermalinks(options) {
+    if (!this.id) {
+      throw new Error("File ID is not set");
+    }
+    const permalinks = await this._fetch({
+      method: "GET",
+      path: `files/${this.id}/permalinks`,
       signal: options?.signal
     });
+    return permalinks.map((data) => new Permalink(this.config, data));
   }
 }
 

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { FileMetadata } from '@meistrari/vault-shared/schemas';
+import { SerializedPermalink, FileMetadata } from '@meistrari/vault-shared/schemas';
 
 interface AuthStrategy {
     getHeaders: () => Headers;
@@ -27,6 +27,58 @@ type VaultConfig = {
     vaultUrl: string;
     authStrategy: AuthStrategy;
 };
+
+declare class Permalink {
+    private readonly config;
+    readonly id: string;
+    readonly workspaceId: string;
+    readonly createdAt: Date;
+    readonly createdBy: string | null;
+    readonly expiresAt: Date | null;
+    readonly fileId: string;
+    constructor(config: VaultConfig, params: SerializedPermalink);
+    /**
+     * The URL for the permalink.
+     */
+    get url(): URL;
+    /**
+     * Get a new permalink instance from its ID.
+     *
+     * @param config - The vault config.
+     * @param id - The permalink ID.
+     * @returns The permalink.
+     */
+    static fromId(config: VaultConfig, id: string): Promise<Permalink>;
+    /**
+     * Create a new permalink.
+     *
+     * @param config - The vault config.
+     * @param params - The parameters for the permalink.
+     * @param params.expiresIn - Time, in seconds, the permalink will be valid for.
+     * @param params.fileId - The ID of the file to create a permalink for.
+     * @param params.workspaceId - The ID of the workspace to create a permalink for.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     *
+     * @returns The permalink.
+     */
+    static create(config: VaultConfig, params: Pick<SerializedPermalink, 'fileId' | 'workspaceId'> & {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Delete the permalink.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     */
+    delete(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+}
+
 type VaultFileParams = {
     id?: string;
     name?: string;
@@ -235,6 +287,7 @@ declare class VaultFile {
      * Fetches a upload URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the upload URL will be valid for
      *
      * @returns The upload URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -242,11 +295,13 @@ declare class VaultFile {
      */
     getUploadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Fetches a download URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the download URL will be valid for
      *
      * @returns The download URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -255,6 +310,7 @@ declare class VaultFile {
      */
     getDownloadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Uploads a file to the vault.
@@ -315,6 +371,30 @@ declare class VaultFile {
     delete(options?: {
         signal?: AbortSignal;
     }): Promise<void>;
+    /**
+     * Creates a permalink for the file.
+     * @param params - The parameters for the permalink
+     * @param params.expiresIn - The number of seconds the permalink will be valid for
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
+     * @returns The permalink for the file
+     */
+    createPermalink(params?: {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Gets a list of the valid permalinks for the file.
+     * @param options - Additional options for the request
+     * @param options.signal - Abort signal
+     *
+     * @returns The permalinks for the file
+     */
+    getPermalinks(options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink[]>;
 }
 
 declare function vaultClient(config: VaultConfig): {

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { FileMetadata } from '@meistrari/vault-shared/schemas';
+import { SerializedPermalink, FileMetadata } from '@meistrari/vault-shared/schemas';
 
 interface AuthStrategy {
     getHeaders: () => Headers;
@@ -27,6 +27,58 @@ type VaultConfig = {
     vaultUrl: string;
     authStrategy: AuthStrategy;
 };
+
+declare class Permalink {
+    private readonly config;
+    readonly id: string;
+    readonly workspaceId: string;
+    readonly createdAt: Date;
+    readonly createdBy: string | null;
+    readonly expiresAt: Date | null;
+    readonly fileId: string;
+    constructor(config: VaultConfig, params: SerializedPermalink);
+    /**
+     * The URL for the permalink.
+     */
+    get url(): URL;
+    /**
+     * Get a new permalink instance from its ID.
+     *
+     * @param config - The vault config.
+     * @param id - The permalink ID.
+     * @returns The permalink.
+     */
+    static fromId(config: VaultConfig, id: string): Promise<Permalink>;
+    /**
+     * Create a new permalink.
+     *
+     * @param config - The vault config.
+     * @param params - The parameters for the permalink.
+     * @param params.expiresIn - Time, in seconds, the permalink will be valid for.
+     * @param params.fileId - The ID of the file to create a permalink for.
+     * @param params.workspaceId - The ID of the workspace to create a permalink for.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     *
+     * @returns The permalink.
+     */
+    static create(config: VaultConfig, params: Pick<SerializedPermalink, 'fileId' | 'workspaceId'> & {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Delete the permalink.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     */
+    delete(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+}
+
 type VaultFileParams = {
     id?: string;
     name?: string;
@@ -235,6 +287,7 @@ declare class VaultFile {
      * Fetches a upload URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the upload URL will be valid for
      *
      * @returns The upload URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -242,11 +295,13 @@ declare class VaultFile {
      */
     getUploadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Fetches a download URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the download URL will be valid for
      *
      * @returns The download URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -255,6 +310,7 @@ declare class VaultFile {
      */
     getDownloadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Uploads a file to the vault.
@@ -315,6 +371,30 @@ declare class VaultFile {
     delete(options?: {
         signal?: AbortSignal;
     }): Promise<void>;
+    /**
+     * Creates a permalink for the file.
+     * @param params - The parameters for the permalink
+     * @param params.expiresIn - The number of seconds the permalink will be valid for
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
+     * @returns The permalink for the file
+     */
+    createPermalink(params?: {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Gets a list of the valid permalinks for the file.
+     * @param options - Additional options for the request
+     * @param options.signal - Abort signal
+     *
+     * @returns The permalinks for the file
+     */
+    getPermalinks(options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink[]>;
 }
 
 declare function vaultClient(config: VaultConfig): {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { FileMetadata } from '@meistrari/vault-shared/schemas';
+import { SerializedPermalink, FileMetadata } from '@meistrari/vault-shared/schemas';
 
 interface AuthStrategy {
     getHeaders: () => Headers;
@@ -27,6 +27,58 @@ type VaultConfig = {
     vaultUrl: string;
     authStrategy: AuthStrategy;
 };
+
+declare class Permalink {
+    private readonly config;
+    readonly id: string;
+    readonly workspaceId: string;
+    readonly createdAt: Date;
+    readonly createdBy: string | null;
+    readonly expiresAt: Date | null;
+    readonly fileId: string;
+    constructor(config: VaultConfig, params: SerializedPermalink);
+    /**
+     * The URL for the permalink.
+     */
+    get url(): URL;
+    /**
+     * Get a new permalink instance from its ID.
+     *
+     * @param config - The vault config.
+     * @param id - The permalink ID.
+     * @returns The permalink.
+     */
+    static fromId(config: VaultConfig, id: string): Promise<Permalink>;
+    /**
+     * Create a new permalink.
+     *
+     * @param config - The vault config.
+     * @param params - The parameters for the permalink.
+     * @param params.expiresIn - Time, in seconds, the permalink will be valid for.
+     * @param params.fileId - The ID of the file to create a permalink for.
+     * @param params.workspaceId - The ID of the workspace to create a permalink for.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     *
+     * @returns The permalink.
+     */
+    static create(config: VaultConfig, params: Pick<SerializedPermalink, 'fileId' | 'workspaceId'> & {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Delete the permalink.
+     *
+     * @param options - Additional options for the request.
+     * @param options.signal - The signal to abort the request.
+     */
+    delete(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+}
+
 type VaultFileParams = {
     id?: string;
     name?: string;
@@ -235,6 +287,7 @@ declare class VaultFile {
      * Fetches a upload URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the upload URL will be valid for
      *
      * @returns The upload URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -242,11 +295,13 @@ declare class VaultFile {
      */
     getUploadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Fetches a download URL for the file.
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
+     * @param options.expiresIn - The number of seconds the download URL will be valid for
      *
      * @returns The download URL for the file
      * @throws {Error} If the vault service returns an invalid response
@@ -255,6 +310,7 @@ declare class VaultFile {
      */
     getDownloadUrl(options?: {
         signal?: AbortSignal;
+        expiresIn?: number;
     }): Promise<URL>;
     /**
      * Uploads a file to the vault.
@@ -315,6 +371,30 @@ declare class VaultFile {
     delete(options?: {
         signal?: AbortSignal;
     }): Promise<void>;
+    /**
+     * Creates a permalink for the file.
+     * @param params - The parameters for the permalink
+     * @param params.expiresIn - The number of seconds the permalink will be valid for
+     * @param options - The options for the request
+     * @param options.signal - The signal to abort the request
+     *
+     * @returns The permalink for the file
+     */
+    createPermalink(params?: {
+        expiresIn?: number;
+    }, options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink>;
+    /**
+     * Gets a list of the valid permalinks for the file.
+     * @param options - Additional options for the request
+     * @param options.signal - Abort signal
+     *
+     * @returns The permalinks for the file
+     */
+    getPermalinks(options?: {
+        signal?: AbortSignal;
+    }): Promise<Permalink[]>;
 }
 
 declare function vaultClient(config: VaultConfig): {

package/dist/index.mjs

@@ -2,15 +2,15 @@ import { GetUploadUrlResponseV2, GetDownloadUrlResponse } from '@meistrari/vault
 import { fileTypeFromBlob } from 'file-type';
 import { lookup } from 'mime-types';
 
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class DataTokenAuthStrategy {
   constructor(dataToken) {
-    __publicField$1(this, "dataToken");
+    __publicField$2(this, "dataToken");
     this.dataToken = dataToken;
   }
   getHeaders() {
@@ -21,7 +21,7 @@ class DataTokenAuthStrategy {
 }
 class APIKeyAuthStrategy {
   constructor(apiKey) {
-    __publicField$1(this, "apiKey");
+    __publicField$2(this, "apiKey");
     this.apiKey = apiKey;
   }
   getHeaders() {
@@ -48,6 +48,103 @@ ${text}`, url, method, response);
   }
 }
 
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Permalink {
+  constructor(config, params) {
+    __publicField$1(this, "config");
+    __publicField$1(this, "id");
+    __publicField$1(this, "workspaceId");
+    __publicField$1(this, "createdAt");
+    __publicField$1(this, "createdBy");
+    __publicField$1(this, "expiresAt");
+    __publicField$1(this, "fileId");
+    this.config = config;
+    this.id = params.id;
+    this.workspaceId = params.workspaceId;
+    this.createdAt = new Date(params.createdAt);
+    this.createdBy = params.createdBy;
+    this.expiresAt = params.expiresAt ? new Date(params.expiresAt) : null;
+    this.fileId = params.fileId;
+  }
+  /**
+   * The URL for the permalink.
+   */
+  get url() {
+    return new URL(`/permalinks/${this.id}`, this.config.vaultUrl);
+  }
+  /**
+   * Get a new permalink instance from its ID.
+   *
+   * @param config - The vault config.
+   * @param id - The permalink ID.
+   * @returns The permalink.
+   */
+  static async fromId(config, id) {
+    const response = await fetch(`${config.vaultUrl}/permalinks/${id}/metadata`, {
+      headers: config.authStrategy.getHeaders()
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "GET", response);
+    }
+    const data = await response.json();
+    return new Permalink(config, data);
+  }
+  /**
+   * Create a new permalink.
+   *
+   * @param config - The vault config.
+   * @param params - The parameters for the permalink.
+   * @param params.expiresIn - Time, in seconds, the permalink will be valid for.
+   * @param params.fileId - The ID of the file to create a permalink for.
+   * @param params.workspaceId - The ID of the workspace to create a permalink for.
+   *
+   * @param options - Additional options for the request.
+   * @param options.signal - The signal to abort the request.
+   *
+   * @returns The permalink.
+   */
+  static async create(config, params, options) {
+    const { expiresIn } = params;
+    const expiresAt = expiresIn ? new Date(Date.now() + expiresIn * 1e3) : void 0;
+    const headers = config.authStrategy.getHeaders();
+    headers.append("x-compatibility-date", "2025-07-29");
+    headers.append("content-type", "application/json");
+    const body = expiresAt ? JSON.stringify({ expiresAt: expiresAt.toISOString() }) : "{}";
+    const response = await fetch(`${config.vaultUrl}/files/${params.fileId}/permalinks`, {
+      method: "POST",
+      signal: options?.signal,
+      headers,
+      body
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "POST", response);
+    }
+    const data = await response.json();
+    return new Permalink(config, data);
+  }
+  /**
+   * Delete the permalink.
+   *
+   * @param options - Additional options for the request.
+   * @param options.signal - The signal to abort the request.
+   */
+  async delete(options) {
+    const response = await fetch(`${this.config.vaultUrl}/permalinks/${this.id}`, {
+      method: "DELETE",
+      signal: options?.signal,
+      headers: this.config.authStrategy.getHeaders()
+    });
+    if (!response.ok) {
+      throw await FetchError.from(response.url, "DELETE", response);
+    }
+  }
+}
+
 async function blobToBase64(blob) {
   const fileContent = new Uint8Array(await blob.arrayBuffer());
   let content = "";
@@ -148,10 +245,15 @@ class VaultFile {
    * @throws {FetchError} If the fetch fails
    */
   async _fetch(params) {
-    const { method, path, body, signal } = params;
-    const url = new URL(this.config.vaultUrl + path).toString();
+    const { method, path, body, signal, query } = params;
+    const url = new URL(path, this.config.vaultUrl);
     const headers = new Headers(this.headers);
     headers.set("x-compatibility-date", compatibilityDate);
+    if (query) {
+      Object.entries(query).forEach(([key, value]) => {
+        url.searchParams.set(key, value);
+      });
+    }
     const response = await wrappedFetch(url, {
       method,
       body,
@@ -176,7 +278,7 @@ class VaultFile {
   async _createFile(metadata = {}, options) {
     const response = await this._fetch({
       method: "POST",
-      path: `/v2/files`,
+      path: `files`,
       body: JSON.stringify({
         ...metadata,
         fileName: this.name,
@@ -235,7 +337,8 @@ class VaultFile {
     const { reference, config, download = false } = params;
     const { vaultUrl, authStrategy } = config;
     const id = removeVaultPrefix(reference);
-    const response = await wrappedFetch(`${vaultUrl}/v2/files/${id}`, {
+    const url = new URL(`files/${id}`, vaultUrl);
+    const response = await wrappedFetch(url, {
       method: "GET",
       headers: authStrategy.getHeaders(),
       signal: options?.signal
@@ -370,7 +473,7 @@ class VaultFile {
     }
     const response = await this._fetch({
       method: "GET",
-      path: `/v2/files/${this.id}/metadata`,
+      path: `files/${this.id}/metadata`,
       signal: options?.signal
     });
     return response;
@@ -379,6 +482,7 @@ class VaultFile {
    * Fetches a upload URL for the file.
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
+   * @param options.expiresIn - The number of seconds the upload URL will be valid for
    *
    * @returns The upload URL for the file
    * @throws {Error} If the vault service returns an invalid response
@@ -398,8 +502,9 @@ class VaultFile {
     }
     const response = await this._fetch({
       method: "PUT",
-      path: `/v2/files/${this.id}`,
-      signal: options?.signal
+      path: `files/${this.id}`,
+      signal: options?.signal,
+      ...options?.expiresIn ? { query: { expiresIn: options.expiresIn.toString() } } : {}
     }).then(GetUploadUrlResponseV2.safeParse);
     if (!response.success) {
       throw new Error(`Invalid response from vault service. ${JSON.stringify(response.error)}`);
@@ -411,6 +516,7 @@ class VaultFile {
    * Fetches a download URL for the file.
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
+   * @param options.expiresIn - The number of seconds the download URL will be valid for
    *
    * @returns The download URL for the file
    * @throws {Error} If the vault service returns an invalid response
@@ -427,8 +533,9 @@ class VaultFile {
     const id = this.id ?? this.metadata?.id ?? (this.content ? await getFileHash(this.content) : this.name);
     const response = await this._fetch({
       method: "GET",
-      path: `/v2/files/${id}`,
-      signal: options?.signal
+      path: `files/${id}`,
+      signal: options?.signal,
+      ...options?.expiresIn ? { query: { expiresIn: options.expiresIn.toString() } } : {}
     });
     this.lastDownloadUrl = { url: new URL(response.url), expiresAt: new Date(response.expiresAt) };
     return this.lastDownloadUrl.url;
@@ -499,9 +606,49 @@ class VaultFile {
     }
     await this._fetch({
       method: "DELETE",
-      path: `/v2/files/${this.id}`,
+      path: `files/${this.id}`,
+      signal: options?.signal
+    });
+  }
+  /**
+   * Creates a permalink for the file.
+   * @param params - The parameters for the permalink
+   * @param params.expiresIn - The number of seconds the permalink will be valid for
+   * @param options - The options for the request
+   * @param options.signal - The signal to abort the request
+   *
+   * @returns The permalink for the file
+   */
+  async createPermalink(params = {}, options) {
+    if (!this.id) {
+      throw new Error("File ID is not set");
+    }
+    if (!this.metadata?.workspaceId) {
+      throw new Error("Workspace ID is not set. Call populateMetadata() to populate the metadata fields.");
+    }
+    return Permalink.create(this.config, {
+      fileId: this.id,
+      workspaceId: this.metadata.workspaceId,
+      expiresIn: params.expiresIn
+    }, options);
+  }
+  /**
+   * Gets a list of the valid permalinks for the file.
+   * @param options - Additional options for the request
+   * @param options.signal - Abort signal
+   *
+   * @returns The permalinks for the file
+   */
+  async getPermalinks(options) {
+    if (!this.id) {
+      throw new Error("File ID is not set");
+    }
+    const permalinks = await this._fetch({
+      method: "GET",
+      path: `files/${this.id}/permalinks`,
       signal: options?.signal
     });
+    return permalinks.map((data) => new Permalink(this.config, data));
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meistrari/vault-sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "UNLICENSED",
   "repository": {
     "type": "git",
@@ -18,12 +18,20 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "test": "vitest --no-watch",
+    "test:watch": "vitest",
+    "build": "unbuild",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "check": "bun run lint && bun tsc --noEmit"
+  },
   "dependencies": {
+    "@meistrari/vault-shared": "0.0.3",
     "file-type": "21.0.0",
     "mime-types": "3.0.1",
     "ofetch": "1.4.1",
-    "zod": "3.23.8",
-    "@meistrari/vault-shared": "0.0.3"
+    "zod": "3.23.8"
   },
   "devDependencies": {
     "@types/bun": "latest",
@@ -37,12 +45,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "test": "vitest",
-    "build": "unbuild",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "check": "bun run lint && bun tsc --noEmit"
   }
 }