@meistrari/vault-sdk 1.4.3 → 1.5.0

package/dist/index.cjs

@@ -200,6 +200,69 @@ async function detectFileMimeType(blob) {
   return void 0;
 }
 
+const name = "@meistrari/vault-sdk";
+const version = "1.5.0";
+const license = "UNLICENSED";
+const repository = {
+	type: "git",
+	url: "https://github.com/meistrari/vault.git"
+};
+const exports$1 = {
+	".": {
+		types: "./dist/index.d.ts",
+		"import": "./dist/index.mjs",
+		require: "./dist/index.cjs"
+	}
+};
+const main = "dist/index.mjs";
+const types = "dist/index.d.ts";
+const files = [
+	"dist"
+];
+const scripts = {
+	test: "vitest --no-watch",
+	"test:watch": "vitest",
+	build: "unbuild",
+	lint: "eslint .",
+	"lint:fix": "eslint . --fix",
+	check: "bun run lint && bun tsc --noEmit"
+};
+const dependencies = {
+	"@meistrari/vault-shared": "workspace:*",
+	"file-type": "21.0.0",
+	"mime-types": "3.0.1",
+	ofetch: "1.4.1",
+	zod: "3.23.8"
+};
+const devDependencies = {
+	"@types/bun": "latest",
+	"@types/mime-types": "3.0.1",
+	msw: "2.6.8",
+	unbuild: "2.0.0",
+	vitest: "2.1.9"
+};
+const peerDependencies = {
+	typescript: "^5.0.0"
+};
+const publishConfig = {
+	access: "public"
+};
+const packageJson = {
+	name: name,
+	version: version,
+	license: license,
+	repository: repository,
+	exports: exports$1,
+	main: main,
+	types: types,
+	files: files,
+	scripts: scripts,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	peerDependencies: peerDependencies,
+	publishConfig: publishConfig
+};
+
 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) => {
@@ -212,6 +275,7 @@ function removeVaultPrefix(url) {
 }
 async function wrappedFetch(...params) {
   const request = new Request(...params);
+  request.headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
   const response = await fetch(request);
   if (!response.ok) {
     throw await FetchError.from(request.url, request.method, response);
@@ -253,7 +317,9 @@ class VaultFile {
    * @returns The headers for the request
    */
   get headers() {
-    return this.config.authStrategy.getHeaders();
+    const headers = this.config.authStrategy.getHeaders();
+    headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+    return headers;
   }
   /**
    * Performs a request to the vault service and handles the response or errors.
@@ -679,6 +745,79 @@ class VaultFile {
   }
 }
 
+function isS3UrlExpired(url) {
+  try {
+    const urlObj = new URL(url);
+    const amzDate = urlObj.searchParams.get("X-Amz-Date");
+    const amzExpires = urlObj.searchParams.get("X-Amz-Expires");
+    if (!amzDate || !amzExpires)
+      return false;
+    const year = Number.parseInt(amzDate.substring(0, 4));
+    const month = Number.parseInt(amzDate.substring(4, 6)) - 1;
+    const day = Number.parseInt(amzDate.substring(6, 8));
+    const hours = Number.parseInt(amzDate.substring(9, 11));
+    const minutes = Number.parseInt(amzDate.substring(11, 13));
+    const seconds = Number.parseInt(amzDate.substring(13, 15));
+    const signedDate = new Date(Date.UTC(year, month, day, hours, minutes, seconds));
+    const expiresInSeconds = Number.parseInt(amzExpires);
+    const expirationTime = signedDate.getTime() + expiresInSeconds * 1e3;
+    const currentTime = Date.now();
+    return currentTime > expirationTime;
+  } catch {
+    return false;
+  }
+}
+function isVaultReference(url) {
+  return url.startsWith("vault://") && url.length === 10;
+}
+function isVaultFileS3Url(url) {
+  const urlObj = new URL(url);
+  const amzDate = urlObj.searchParams.get("X-Amz-Date");
+  const amzExpires = urlObj.searchParams.get("X-Amz-Expires");
+  return urlObj.hostname.includes("amazonaws.com") && Boolean(amzDate) && Boolean(amzExpires);
+}
+const URL_STRATEGIES = [
+  {
+    separator: "/",
+    extractSegments: ([workspaceId, vaultFileId]) => ({
+      workspaceId,
+      vaultFileId
+    })
+  },
+  {
+    separator: "_",
+    extractSegments: ([vaultFileId, workspaceId]) => ({
+      vaultFileId,
+      workspaceId
+    })
+  }
+];
+function extractVaultFileIdFromS3Url(url) {
+  if (isVaultReference(url))
+    return url.replace("vault://", "");
+  try {
+    if (!isVaultFileS3Url(url))
+      return null;
+    const urlObj = new URL(url);
+    const strategy = URL_STRATEGIES.find((strategy2) => urlObj.pathname.includes(strategy2.separator));
+    if (!strategy)
+      return null;
+    const segments = urlObj.pathname.split(strategy.separator).filter((segment) => segment.length > 0);
+    if (segments.length < 2)
+      return null;
+    const extractedIds = strategy.extractSegments(segments);
+    if (!extractedIds || !extractedIds.vaultFileId || !extractedIds.workspaceId || extractedIds.vaultFileId.length < 32)
+      return null;
+    return extractedIds.vaultFileId;
+  } catch {
+    return null;
+  }
+}
+function convertS3UrlToVaultReference(url) {
+  const vaultFileId = extractVaultFileIdFromS3Url(url);
+  return vaultFileId ? `vault://${vaultFileId}` : null;
+}
+
 function vaultClient(vaultConfig) {
   const config = resolveConfig(vaultConfig);
   function createFromContent(name, content, options) {
@@ -701,4 +840,8 @@ exports.APIKeyAuthStrategy = APIKeyAuthStrategy;
 exports.DataTokenAuthStrategy = DataTokenAuthStrategy;
 exports.FetchError = FetchError;
 exports.VaultFile = VaultFile;
+exports.convertS3UrlToVaultReference = convertS3UrlToVaultReference;
+exports.extractVaultFileIdFromS3Url = extractVaultFileIdFromS3Url;
+exports.isS3UrlExpired = isS3UrlExpired;
+exports.isVaultFileS3Url = isVaultFileS3Url;
 exports.vaultClient = vaultClient;

package/dist/index.d.cts

@@ -399,6 +399,36 @@ declare class VaultFile {
     }): Promise<Permalink[]>;
 }
 
+/**
+ * Checks if an Amazon S3 signed URL has expired
+ * @param url - The S3 URL to check for expiration
+ * @returns true if the URL is expired, false if it's still valid or not an S3 signed URL
+ * @example
+ * const expired = isS3UrlExpired('https://vault-prod.s3.amazonaws.com/file?X-Amz-Date=20240101T000000Z&X-Amz-Expires=3600')
+ */
+declare function isS3UrlExpired(url: string): boolean;
+/**
+ * Checks if a URL is a valid S3 vault URL
+ * @param url - The S3 URL to check
+ * @returns true if the URL is a valid S3 vault URL, false otherwise
+ */
+declare function isVaultFileS3Url(url: string): boolean;
+/**
+ * Detects if a URL is an expired S3 vault URL and extracts the vault file ID
+ * Returns null if not a vault S3 URL, not expired, or extraction fails
+ */
+declare function extractVaultFileIdFromS3Url(url: string): string | null;
+/**
+ * Converts an S3 vault URL to a vault reference format
+ * Extracts the vault file ID from the S3 URL path and formats it as vault://[fileId]
+ * @param url - The S3 vault URL to convert
+ * @returns A vault reference string (vault://[fileId]) if successful, null if the URL is not a valid vault S3 URL
+ * @example
+ * const ref = convertS3UrlToVaultReference('https://vault-prod.s3.amazonaws.com/workspace123/2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6?...')
+ * // Returns: 'vault://2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6'
+ */
+declare function convertS3UrlToVaultReference(url: string): string | null;
+
 declare function vaultClient(vaultConfig: VaultConfig): {
     createFromContent: (name: string, content: Blob | File, options?: {
         signal?: AbortSignal;
@@ -408,5 +438,5 @@ declare function vaultClient(vaultConfig: VaultConfig): {
     }) => Promise<VaultFile>;
 };
 
-export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, isS3UrlExpired, isVaultFileS3Url, vaultClient };
 export type { AuthStrategy, VaultConfig };

package/dist/index.d.mts

@@ -399,6 +399,36 @@ declare class VaultFile {
     }): Promise<Permalink[]>;
 }
 
+/**
+ * Checks if an Amazon S3 signed URL has expired
+ * @param url - The S3 URL to check for expiration
+ * @returns true if the URL is expired, false if it's still valid or not an S3 signed URL
+ * @example
+ * const expired = isS3UrlExpired('https://vault-prod.s3.amazonaws.com/file?X-Amz-Date=20240101T000000Z&X-Amz-Expires=3600')
+ */
+declare function isS3UrlExpired(url: string): boolean;
+/**
+ * Checks if a URL is a valid S3 vault URL
+ * @param url - The S3 URL to check
+ * @returns true if the URL is a valid S3 vault URL, false otherwise
+ */
+declare function isVaultFileS3Url(url: string): boolean;
+/**
+ * Detects if a URL is an expired S3 vault URL and extracts the vault file ID
+ * Returns null if not a vault S3 URL, not expired, or extraction fails
+ */
+declare function extractVaultFileIdFromS3Url(url: string): string | null;
+/**
+ * Converts an S3 vault URL to a vault reference format
+ * Extracts the vault file ID from the S3 URL path and formats it as vault://[fileId]
+ * @param url - The S3 vault URL to convert
+ * @returns A vault reference string (vault://[fileId]) if successful, null if the URL is not a valid vault S3 URL
+ * @example
+ * const ref = convertS3UrlToVaultReference('https://vault-prod.s3.amazonaws.com/workspace123/2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6?...')
+ * // Returns: 'vault://2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6'
+ */
+declare function convertS3UrlToVaultReference(url: string): string | null;
+
 declare function vaultClient(vaultConfig: VaultConfig): {
     createFromContent: (name: string, content: Blob | File, options?: {
         signal?: AbortSignal;
@@ -408,5 +438,5 @@ declare function vaultClient(vaultConfig: VaultConfig): {
     }) => Promise<VaultFile>;
 };
 
-export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, isS3UrlExpired, isVaultFileS3Url, vaultClient };
 export type { AuthStrategy, VaultConfig };

package/dist/index.d.ts

@@ -399,6 +399,36 @@ declare class VaultFile {
     }): Promise<Permalink[]>;
 }
 
+/**
+ * Checks if an Amazon S3 signed URL has expired
+ * @param url - The S3 URL to check for expiration
+ * @returns true if the URL is expired, false if it's still valid or not an S3 signed URL
+ * @example
+ * const expired = isS3UrlExpired('https://vault-prod.s3.amazonaws.com/file?X-Amz-Date=20240101T000000Z&X-Amz-Expires=3600')
+ */
+declare function isS3UrlExpired(url: string): boolean;
+/**
+ * Checks if a URL is a valid S3 vault URL
+ * @param url - The S3 URL to check
+ * @returns true if the URL is a valid S3 vault URL, false otherwise
+ */
+declare function isVaultFileS3Url(url: string): boolean;
+/**
+ * Detects if a URL is an expired S3 vault URL and extracts the vault file ID
+ * Returns null if not a vault S3 URL, not expired, or extraction fails
+ */
+declare function extractVaultFileIdFromS3Url(url: string): string | null;
+/**
+ * Converts an S3 vault URL to a vault reference format
+ * Extracts the vault file ID from the S3 URL path and formats it as vault://[fileId]
+ * @param url - The S3 vault URL to convert
+ * @returns A vault reference string (vault://[fileId]) if successful, null if the URL is not a valid vault S3 URL
+ * @example
+ * const ref = convertS3UrlToVaultReference('https://vault-prod.s3.amazonaws.com/workspace123/2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6?...')
+ * // Returns: 'vault://2fce574083da49fe3f10b32205893ec0bb024fe1c7673fa54927fdfe1d0db9d6'
+ */
+declare function convertS3UrlToVaultReference(url: string): string | null;
+
 declare function vaultClient(vaultConfig: VaultConfig): {
     createFromContent: (name: string, content: Blob | File, options?: {
         signal?: AbortSignal;
@@ -408,5 +438,5 @@ declare function vaultClient(vaultConfig: VaultConfig): {
     }) => Promise<VaultFile>;
 };
 
-export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, isS3UrlExpired, isVaultFileS3Url, vaultClient };
 export type { AuthStrategy, VaultConfig };

package/dist/index.mjs

@@ -198,6 +198,69 @@ async function detectFileMimeType(blob) {
   return void 0;
 }
 
+const name = "@meistrari/vault-sdk";
+const version = "1.5.0";
+const license = "UNLICENSED";
+const repository = {
+	type: "git",
+	url: "https://github.com/meistrari/vault.git"
+};
+const exports = {
+	".": {
+		types: "./dist/index.d.ts",
+		"import": "./dist/index.mjs",
+		require: "./dist/index.cjs"
+	}
+};
+const main = "dist/index.mjs";
+const types = "dist/index.d.ts";
+const files = [
+	"dist"
+];
+const scripts = {
+	test: "vitest --no-watch",
+	"test:watch": "vitest",
+	build: "unbuild",
+	lint: "eslint .",
+	"lint:fix": "eslint . --fix",
+	check: "bun run lint && bun tsc --noEmit"
+};
+const dependencies = {
+	"@meistrari/vault-shared": "workspace:*",
+	"file-type": "21.0.0",
+	"mime-types": "3.0.1",
+	ofetch: "1.4.1",
+	zod: "3.23.8"
+};
+const devDependencies = {
+	"@types/bun": "latest",
+	"@types/mime-types": "3.0.1",
+	msw: "2.6.8",
+	unbuild: "2.0.0",
+	vitest: "2.1.9"
+};
+const peerDependencies = {
+	typescript: "^5.0.0"
+};
+const publishConfig = {
+	access: "public"
+};
+const packageJson = {
+	name: name,
+	version: version,
+	license: license,
+	repository: repository,
+	exports: exports,
+	main: main,
+	types: types,
+	files: files,
+	scripts: scripts,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	peerDependencies: peerDependencies,
+	publishConfig: publishConfig
+};
+
 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) => {
@@ -210,6 +273,7 @@ function removeVaultPrefix(url) {
 }
 async function wrappedFetch(...params) {
   const request = new Request(...params);
+  request.headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
   const response = await fetch(request);
   if (!response.ok) {
     throw await FetchError.from(request.url, request.method, response);
@@ -251,7 +315,9 @@ class VaultFile {
    * @returns The headers for the request
    */
   get headers() {
-    return this.config.authStrategy.getHeaders();
+    const headers = this.config.authStrategy.getHeaders();
+    headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+    return headers;
   }
   /**
    * Performs a request to the vault service and handles the response or errors.
@@ -677,6 +743,79 @@ class VaultFile {
   }
 }
 
+function isS3UrlExpired(url) {
+  try {
+    const urlObj = new URL(url);
+    const amzDate = urlObj.searchParams.get("X-Amz-Date");
+    const amzExpires = urlObj.searchParams.get("X-Amz-Expires");
+    if (!amzDate || !amzExpires)
+      return false;
+    const year = Number.parseInt(amzDate.substring(0, 4));
+    const month = Number.parseInt(amzDate.substring(4, 6)) - 1;
+    const day = Number.parseInt(amzDate.substring(6, 8));
+    const hours = Number.parseInt(amzDate.substring(9, 11));
+    const minutes = Number.parseInt(amzDate.substring(11, 13));
+    const seconds = Number.parseInt(amzDate.substring(13, 15));
+    const signedDate = new Date(Date.UTC(year, month, day, hours, minutes, seconds));
+    const expiresInSeconds = Number.parseInt(amzExpires);
+    const expirationTime = signedDate.getTime() + expiresInSeconds * 1e3;
+    const currentTime = Date.now();
+    return currentTime > expirationTime;
+  } catch {
+    return false;
+  }
+}
+function isVaultReference(url) {
+  return url.startsWith("vault://") && url.length === 10;
+}
+function isVaultFileS3Url(url) {
+  const urlObj = new URL(url);
+  const amzDate = urlObj.searchParams.get("X-Amz-Date");
+  const amzExpires = urlObj.searchParams.get("X-Amz-Expires");
+  return urlObj.hostname.includes("amazonaws.com") && Boolean(amzDate) && Boolean(amzExpires);
+}
+const URL_STRATEGIES = [
+  {
+    separator: "/",
+    extractSegments: ([workspaceId, vaultFileId]) => ({
+      workspaceId,
+      vaultFileId
+    })
+  },
+  {
+    separator: "_",
+    extractSegments: ([vaultFileId, workspaceId]) => ({
+      vaultFileId,
+      workspaceId
+    })
+  }
+];
+function extractVaultFileIdFromS3Url(url) {
+  if (isVaultReference(url))
+    return url.replace("vault://", "");
+  try {
+    if (!isVaultFileS3Url(url))
+      return null;
+    const urlObj = new URL(url);
+    const strategy = URL_STRATEGIES.find((strategy2) => urlObj.pathname.includes(strategy2.separator));
+    if (!strategy)
+      return null;
+    const segments = urlObj.pathname.split(strategy.separator).filter((segment) => segment.length > 0);
+    if (segments.length < 2)
+      return null;
+    const extractedIds = strategy.extractSegments(segments);
+    if (!extractedIds || !extractedIds.vaultFileId || !extractedIds.workspaceId || extractedIds.vaultFileId.length < 32)
+      return null;
+    return extractedIds.vaultFileId;
+  } catch {
+    return null;
+  }
+}
+function convertS3UrlToVaultReference(url) {
+  const vaultFileId = extractVaultFileIdFromS3Url(url);
+  return vaultFileId ? `vault://${vaultFileId}` : null;
+}
+
 function vaultClient(vaultConfig) {
   const config = resolveConfig(vaultConfig);
   function createFromContent(name, content, options) {
@@ -695,4 +834,4 @@ function vaultClient(vaultConfig) {
   return { createFromContent, createFromReference };
 }
 
-export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, vaultClient };
+export { APIKeyAuthStrategy, DataTokenAuthStrategy, FetchError, VaultFile, convertS3UrlToVaultReference, extractVaultFileIdFromS3Url, isS3UrlExpired, isVaultFileS3Url, vaultClient };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@meistrari/vault-sdk",
-    "version": "1.4.3",
+    "version": "1.5.0",
     "license": "UNLICENSED",
     "repository": {
         "type": "git",