@meistrari/vault-sdk 3.2.1 → 3.4.0

package/dist/index.mjs

@@ -1,17 +1,17 @@
-import { GetUploadUrlResponseV2, GetDownloadUrlResponse } from '@meistrari/vault-shared/schemas';
+import { CreateAssetUploadResponse, GetUploadUrlResponseV2, GetDownloadUrlResponse } from '@meistrari/vault-shared/schemas';
 import { fileTypeFromBlob } from '@meistrari/file-type';
 import { lookup } from 'mime-types';
 import vaultUtils from '@meistrari/vault-shared/utils';
 
-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);
+var __defProp$3 = Object.defineProperty;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$3 = (obj, key, value) => {
+  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
 class DataTokenAuthStrategy {
   constructor(dataToken) {
-    __publicField$2(this, "dataToken");
+    __publicField$3(this, "dataToken");
     this.dataToken = dataToken;
   }
   getHeaders() {
@@ -22,7 +22,7 @@ class DataTokenAuthStrategy {
 }
 class APIKeyAuthStrategy {
   constructor(apiKey) {
-    __publicField$2(this, "apiKey");
+    __publicField$3(this, "apiKey");
     this.apiKey = apiKey;
   }
   getHeaders() {
@@ -62,116 +62,6 @@ function resolveConfig(config) {
   };
 }
 
-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(vaultConfig, 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");
-    __publicField$1(this, "baseUrl");
-    const config = resolveConfig(vaultConfig);
-    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;
-    this.baseUrl = config.vaultUrl;
-  }
-  /**
-   * The URL for the permalink.
-   */
-  get url() {
-    return new URL(`permalinks/${this.id}`, this.baseUrl);
-  }
-  /**
-   * Get a new permalink instance from its ID.
-   *
-   * @param vaultConfig - The vault config.
-   * @param id - The permalink ID.
-   * @returns The permalink.
-   */
-  static async fromId(vaultConfig, id) {
-    const config = resolveConfig(vaultConfig);
-    const response = await fetch(new URL(`permalinks/${id}/metadata`, config.vaultUrl), {
-      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 vaultConfig - 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(vaultConfig, params, options) {
-    const config = resolveConfig(vaultConfig);
-    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(new URL(`files/${params.fileId}/permalinks`, config.vaultUrl), {
-      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(new URL(`permalinks/${this.id}`, this.baseUrl), {
-      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 = "";
-  for (const part of fileContent)
-    content += String.fromCharCode(part);
-  return btoa(content);
-}
-
 async function getFileHash(blob) {
   const arrayBuffer = await blob.arrayBuffer();
   const hashBuffer = await crypto.subtle.digest("SHA-256", arrayBuffer);
@@ -181,7 +71,7 @@ async function getFileHash(blob) {
 }
 async function detectFileMimeType(blob) {
   if (blob instanceof Blob && blob.type) {
-    return blob.type.split(";")[0].trim();
+    return blob.type.split(";")[0]?.trim();
   }
   if ("name" in blob && typeof blob.name === "string") {
     const extension = blob.name.split(".").pop()?.toLowerCase();
@@ -209,7 +99,7 @@ async function detectFileMimeType(blob) {
   if (lines.length > 1) {
     const commaCounts = lines.map((line) => (line.match(/,/g) || []).length);
     const allSame = commaCounts.every((count) => count === commaCounts[0]);
-    if (allSame && commaCounts[0] > 0) {
+    if (allSame && (commaCounts[0] ?? 0) > 0) {
       return "text/csv";
     }
   }
@@ -241,7 +131,7 @@ function getFileName(content) {
 }
 
 const name = "@meistrari/vault-sdk";
-const version = "3.2.1";
+const version = "3.4.0";
 const license = "UNLICENSED";
 const repository = {
 	type: "git",
@@ -269,13 +159,13 @@ const scripts = {
 };
 const dependencies = {
 	"@meistrari/file-type": "22.0.0",
-	"@meistrari/vault-shared": "0.1.2",
+	"@meistrari/vault-shared": "0.2.0",
 	"mime-types": "3.0.1",
 	ofetch: "1.4.1",
 	zod: "4.3.6"
 };
 const devDependencies = {
-	"@types/bun": "latest",
+	"@types/bun": "1.3.14",
 	"@types/mime-types": "3.0.1",
 	msw: "2.6.8",
 	unbuild: "2.0.0",
@@ -306,6 +196,258 @@ const packageJson = {
 const serviceName = typeof process !== "undefined" ? process?.env?.SERVICE_NAME : "";
 const userAgent = `vault-js-sdk:${packageJson.version}${serviceName ? `@${serviceName}` : ""}`.trim();
 
+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;
+};
+const compatibilityDate$1 = "2025-05-19";
+async function wrappedFetch$1(url, requestInit) {
+  const request = new Request(url, requestInit);
+  request.headers.set("User-Agent", userAgent);
+  request.headers.set("x-compatibility-date", compatibilityDate$1);
+  const response = await fetch(request);
+  if (!response.ok) {
+    throw await FetchError.from(request.url, request.method, response);
+  }
+  return response;
+}
+class VaultAsset {
+  /**
+   * Constructs a VaultAsset instance from Vault response data.
+   *
+   * Direct usage of the constructor is not usually needed. Prefer
+   * {@link VaultAsset.create} or {@link VaultAsset.fromContent}.
+   *
+   * @param params - Values returned by Vault when creating an asset upload.
+   * @param params.assetId - Vault-assigned asset ID.
+   * @param params.assetUrl - Stable URL used to resolve or download the asset.
+   * @param params.uploadUrl - Presigned URL used to upload the asset content.
+   * @param params.expiresAt - Expiration time for the presigned upload URL.
+   * @param params.uploadHeaders - Headers required by the presigned upload URL.
+   * @param params.asset - Stored asset metadata returned by Vault.
+   */
+  constructor({ assetId, assetUrl, uploadUrl, expiresAt, uploadHeaders, asset }) {
+    /** Vault-assigned asset ID. */
+    __publicField$2(this, "assetId");
+    /** Stable URL used to resolve or download the asset. */
+    __publicField$2(this, "assetUrl");
+    /** Presigned URL used to upload asset content. */
+    __publicField$2(this, "uploadUrl");
+    /** Expiration time for the presigned upload URL. */
+    __publicField$2(this, "expiresAt");
+    /** Headers that must be sent when uploading to {@link VaultAsset.uploadUrl}. */
+    __publicField$2(this, "uploadHeaders");
+    /** Stored asset metadata returned by Vault. */
+    __publicField$2(this, "asset");
+    this.assetId = assetId;
+    this.assetUrl = new URL(assetUrl);
+    this.uploadUrl = new URL(uploadUrl);
+    this.expiresAt = new Date(expiresAt);
+    this.uploadHeaders = uploadHeaders;
+    this.asset = asset;
+  }
+  /**
+   * Creates an asset upload URL without uploading content.
+   *
+   * Use {@link VaultAsset.upload} to upload content later, or use
+   * {@link VaultAsset.fromContent} with `upload: true` to create and upload in one call.
+   *
+   * @param vaultConfig - Vault client configuration.
+   * @param params - Parameters for the asset upload.
+   * @param params.assetClass - Application-defined class for grouping assets.
+   * @param params.subject - Opaque application-owned entity reference for lookup and cleanup. Use a stable namespaced value such as `user:user_123`; Vault does not interpret it or include it in the asset URL.
+   * @param params.mimeType - MIME type of the content that will be uploaded.
+   * @param params.size - Size of the content in bytes, when known.
+   * @param options - Additional options for the request.
+   * @param options.signal - Signal used to abort the request.
+   * @returns A VaultAsset containing the asset URL and presigned upload URL.
+   * @throws {FetchError} If Vault rejects the create request.
+   * @throws {Error} If Vault returns a response that does not match the SDK schema.
+   */
+  static async create(vaultConfig, params, options) {
+    const config = resolveConfig(vaultConfig);
+    const headers = config.authStrategy.getHeaders();
+    headers.set("content-type", "application/json");
+    const response = await wrappedFetch$1(new URL("assets", config.vaultUrl), {
+      method: "POST",
+      signal: options?.signal,
+      headers,
+      body: JSON.stringify({
+        assetClass: params.assetClass,
+        subject: params.subject,
+        mimeType: params.mimeType,
+        size: params.size
+      })
+    }).then(async (response2) => await response2.json()).then((data) => CreateAssetUploadResponse.safeParse(data));
+    if (!response.success) {
+      throw new Error(`Invalid response from vault service. ${JSON.stringify(response.error)}`);
+    }
+    return new VaultAsset(response.data);
+  }
+  /**
+   * Creates an asset from Blob or File content.
+   *
+   * The SDK detects the MIME type when `params.mimeType` is omitted. Set
+   * `params.upload` to `true` to upload the content immediately.
+   *
+   * @param vaultConfig - Vault client configuration.
+   * @param content - Content to associate with the asset.
+   * @param params - Parameters for the asset.
+   * @param params.assetClass - Application-defined class for grouping assets.
+   * @param params.subject - Opaque application-owned entity reference for lookup and cleanup. Use a stable namespaced value such as `user:user_123`; Vault does not interpret it or include it in the asset URL.
+   * @param params.mimeType - MIME type override for the content.
+   * @param params.upload - Whether to upload the content immediately after creating the asset.
+   * @param options - Additional options for the create and upload requests.
+   * @param options.signal - Signal used to abort either request.
+   * @returns A VaultAsset containing the asset URL and presigned upload URL.
+   * @throws {FetchError} If Vault rejects the create request or the upload request fails.
+   * @throws {Error} If Vault returns a response that does not match the SDK schema.
+   */
+  static async fromContent(vaultConfig, content, params, options) {
+    const mimeType = params.mimeType ?? await detectFileMimeType(content) ?? "application/octet-stream";
+    const asset = await VaultAsset.create(vaultConfig, {
+      assetClass: params.assetClass,
+      subject: params.subject,
+      mimeType,
+      size: content.size
+    }, options);
+    if (params.upload) {
+      await asset.upload(content, options);
+    }
+    return asset;
+  }
+  /**
+   * Uploads content to this asset's presigned upload URL.
+   *
+   * The upload request sends the headers returned by Vault when the asset was created.
+   *
+   * @param content - Content to upload.
+   * @param options - Additional options for the upload request.
+   * @param options.signal - Signal used to abort the upload.
+   * @throws {FetchError} If the upload endpoint returns an error response.
+   */
+  async upload(content, options) {
+    await wrappedFetch$1(this.uploadUrl, {
+      method: "PUT",
+      signal: options?.signal,
+      headers: new Headers(this.uploadHeaders),
+      body: content
+    });
+  }
+}
+
+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(vaultConfig, 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");
+    __publicField$1(this, "baseUrl");
+    const config = resolveConfig(vaultConfig);
+    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;
+    this.baseUrl = config.vaultUrl;
+  }
+  /**
+   * The URL for the permalink.
+   */
+  get url() {
+    return new URL(`permalinks/${this.id}`, this.baseUrl);
+  }
+  /**
+   * Get a new permalink instance from its ID.
+   *
+   * @param vaultConfig - The vault config.
+   * @param id - The permalink ID.
+   * @returns The permalink.
+   */
+  static async fromId(vaultConfig, id) {
+    const config = resolveConfig(vaultConfig);
+    const response = await fetch(new URL(`permalinks/${id}/metadata`, config.vaultUrl), {
+      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 vaultConfig - 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(vaultConfig, params, options) {
+    const config = resolveConfig(vaultConfig);
+    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(new URL(`files/${params.fileId}/permalinks`, config.vaultUrl), {
+      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(new URL(`permalinks/${this.id}`, this.baseUrl), {
+      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 = "";
+  for (const part of fileContent)
+    content += String.fromCharCode(part);
+  return btoa(content);
+}
+
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => {
@@ -2018,7 +2160,38 @@ function vaultClient(vaultConfig) {
       config
     }, { signal: options?.signal });
   }
-  return { createFromContent, createFromReference, createFromStream, createFromContentBulk, createFromStreamBulk };
+  const assets = {
+    /**
+     * Creates an asset upload URL without uploading content.
+     *
+     * `params.subject` should be a stable application-owned entity reference such as
+     * `user:user_123` or `organization:org_123`. Vault stores it for lookup and cleanup,
+     * but does not interpret it, enforce authorization from it, or include it in the asset URL.
+     *
+     * @param params - Parameters for the asset upload.
+     * @param options - Additional options for the request.
+     * @returns A VaultAsset with the stable asset URL and presigned upload URL.
+     */
+    async create(params, options) {
+      return await VaultAsset.create(config, params, { signal: options?.signal });
+    },
+    /**
+     * Creates an asset from File or Blob content and optionally uploads it immediately.
+     *
+     * `params.subject` should be a stable application-owned entity reference such as
+     * `user:user_123` or `organization:org_123`. Vault stores it for lookup and cleanup,
+     * but does not interpret it, enforce authorization from it, or include it in the asset URL.
+     *
+     * @param content - File or Blob content to associate with the asset.
+     * @param params - Parameters for the asset.
+     * @param options - Additional options for the create and upload requests.
+     * @returns A VaultAsset with the stable asset URL and presigned upload URL.
+     */
+    async createFromContent(content, params, options) {
+      return await VaultAsset.fromContent(config, content, params, { signal: options?.signal });
+    }
+  };
+  return { createFromContent, createFromReference, createFromStream, createFromContentBulk, createFromStreamBulk, assets };
 }
 
-export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, extractVaultReferences, getVaultParamsFromS3Url, isS3UrlExpired, isTaggedVaultPresignedUrl, isPresignedS3Url as isVaultFileS3Url, isVaultReference, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, Permalink, VaultAsset, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, extractVaultReferences, getVaultParamsFromS3Url, isS3UrlExpired, isTaggedVaultPresignedUrl, isPresignedS3Url as isVaultFileS3Url, isVaultReference, vaultClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meistrari/vault-sdk",
-  "version": "3.2.1",
+  "version": "3.4.0",
   "license": "UNLICENSED",
   "repository": {
     "type": "git",
@@ -28,13 +28,13 @@
   },
   "dependencies": {
     "@meistrari/file-type": "22.0.0",
-    "@meistrari/vault-shared": "0.1.2",
+    "@meistrari/vault-shared": "0.2.0",
     "mime-types": "3.0.1",
     "ofetch": "1.4.1",
     "zod": "4.3.6"
   },
   "devDependencies": {
-    "@types/bun": "latest",
+    "@types/bun": "1.3.14",
     "@types/mime-types": "3.0.1",
     "msw": "2.6.8",
     "unbuild": "2.0.0",