@meistrari/vault-sdk 1.8.2 → 1.9.0

package/README.md

@@ -5,7 +5,7 @@ This is the SDK for Vault V2.
 ## Installation
 
 ```bash
-ni @meistrari/vault-sdk-sdk
+ni @meistrari/vault-sdk
 ```
 
 ## Table of Contents

package/dist/index.cjs

@@ -237,7 +237,7 @@ function getFileName(content) {
 }
 
 const name = "@meistrari/vault-sdk";
-const version = "1.8.2";
+const version = "1.9.0";
 const license = "UNLICENSED";
 const repository = {
 	type: "git",
@@ -299,6 +299,9 @@ const packageJson = {
 	publishConfig: publishConfig
 };
 
+const serviceName = typeof process !== "undefined" ? process?.env?.SERVICE_NAME : "";
+const userAgent = `vault-js-sdk:${packageJson.version}${serviceName ? `@${serviceName}` : ""}`.trim();
+
 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) => {
@@ -322,7 +325,7 @@ async function wrappedFetch(url, requestInit) {
     duplex: requestInit.body instanceof ReadableStream ? "half" : void 0
   };
   const request = new Request(url, options);
-  request.headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+  request.headers.set("User-Agent", userAgent);
   const response = await fetch(request);
   if (!response.ok) {
     throw await FetchError.from(request.url, request.method, response);
@@ -367,7 +370,7 @@ class VaultFile {
    */
   get headers() {
     const headers = this.config.authStrategy.getHeaders();
-    headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+    headers.set("User-Agent", userAgent);
     return headers;
   }
   /**
@@ -413,6 +416,8 @@ class VaultFile {
    * @param metadata.size - The size of the file
    * @param metadata.mimeType - The mime type of the file
    * @param metadata.parentId - The ID of the parent file for hierarchical file relationships
+   * @param metadata.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param metadata.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -428,6 +433,8 @@ class VaultFile {
         size: metadata.size,
         mimeType: metadata.mimeType,
         parentId: metadata.parentId,
+        onMissingParent: metadata.onMissingParent,
+        onParentConflict: metadata.onParentConflict,
         fileName: this.name,
         sha256sum: this.id ?? this.metadata?.id ?? (this.content ? await getFileHash(this.content) : void 0)
       }),
@@ -518,6 +525,8 @@ class VaultFile {
    * @param params.mimeType - The MIME type of the file (optional)
    * @param params.upload - Whether to upload the file (default: false)
    * @param params.parentId - The ID of the parent file for hierarchical file relationships
+   * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param params.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -570,7 +579,7 @@ class VaultFile {
    * ```
    */
   static async fromContent(params, options) {
-    const { content, config: vaultConfig, upload = false, parentId } = params;
+    const { content, config: vaultConfig, upload = false, parentId, onMissingParent, onParentConflict } = params;
     const name = basename(params.name) ?? getFileName(content);
     const config = resolveConfig(vaultConfig);
     const { vaultUrl, authStrategy } = config;
@@ -589,7 +598,9 @@ class VaultFile {
     const createdFile = await file._createFile({
       size,
       mimeType,
-      parentId
+      parentId,
+      onMissingParent,
+      onParentConflict
     }, { signal: options?.signal });
     if (upload) {
       await file.upload(file.content, createdFile.uploadUrl, { signal: options?.signal });
@@ -606,6 +617,8 @@ class VaultFile {
    * @param params.config - The configuration for the VaultFile
    * @param params.contentType - The MIME type of the content (optional)
    * @param params.parentId - The ID of the parent file for hierarchical file relationships
+   * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param params.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -642,14 +655,23 @@ class VaultFile {
    * ```
    */
   static async fromStream(params, options) {
-    const { contentLength, config: vaultConfig, contentType, parentId } = params;
+    const {
+      contentLength,
+      config: vaultConfig,
+      contentType,
+      parentId,
+      onMissingParent,
+      onParentConflict
+    } = params;
     const name = basename(params.name);
     const config = resolveConfig(vaultConfig);
     const file = new VaultFile({ config, name });
     await file._createFile({
       size: contentLength,
       mimeType: contentType || "application/octet-stream",
-      parentId
+      parentId,
+      onMissingParent,
+      onParentConflict
     }, { signal: options?.signal });
     return file;
   }

package/dist/index.d.cts

@@ -87,6 +87,8 @@ type VaultFileParams = {
     metadata?: FileMetadata | null;
     config: VaultConfig;
 };
+type OnMissingParent = 'error' | 'create-as-root';
+type OnParentConflict = 'error' | 'update-parent-id' | 'ignore';
 /**
  * Represents a file in the vault and allows interacting with it.
  *
@@ -152,6 +154,8 @@ declare class VaultFile {
      * @param metadata.size - The size of the file
      * @param metadata.mimeType - The mime type of the file
      * @param metadata.parentId - The ID of the parent file for hierarchical file relationships
+     * @param metadata.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param metadata.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -216,6 +220,8 @@ declare class VaultFile {
      * @param params.mimeType - The MIME type of the file (optional)
      * @param params.upload - Whether to upload the file (default: false)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -274,6 +280,8 @@ declare class VaultFile {
         mimeType?: string;
         upload?: boolean;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;
@@ -287,6 +295,8 @@ declare class VaultFile {
      * @param params.config - The configuration for the VaultFile
      * @param params.contentType - The MIME type of the content (optional)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -328,6 +338,8 @@ declare class VaultFile {
         config: VaultConfig;
         contentType?: string;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;

package/dist/index.d.mts

@@ -87,6 +87,8 @@ type VaultFileParams = {
     metadata?: FileMetadata | null;
     config: VaultConfig;
 };
+type OnMissingParent = 'error' | 'create-as-root';
+type OnParentConflict = 'error' | 'update-parent-id' | 'ignore';
 /**
  * Represents a file in the vault and allows interacting with it.
  *
@@ -152,6 +154,8 @@ declare class VaultFile {
      * @param metadata.size - The size of the file
      * @param metadata.mimeType - The mime type of the file
      * @param metadata.parentId - The ID of the parent file for hierarchical file relationships
+     * @param metadata.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param metadata.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -216,6 +220,8 @@ declare class VaultFile {
      * @param params.mimeType - The MIME type of the file (optional)
      * @param params.upload - Whether to upload the file (default: false)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -274,6 +280,8 @@ declare class VaultFile {
         mimeType?: string;
         upload?: boolean;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;
@@ -287,6 +295,8 @@ declare class VaultFile {
      * @param params.config - The configuration for the VaultFile
      * @param params.contentType - The MIME type of the content (optional)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -328,6 +338,8 @@ declare class VaultFile {
         config: VaultConfig;
         contentType?: string;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;

package/dist/index.d.ts

@@ -87,6 +87,8 @@ type VaultFileParams = {
     metadata?: FileMetadata | null;
     config: VaultConfig;
 };
+type OnMissingParent = 'error' | 'create-as-root';
+type OnParentConflict = 'error' | 'update-parent-id' | 'ignore';
 /**
  * Represents a file in the vault and allows interacting with it.
  *
@@ -152,6 +154,8 @@ declare class VaultFile {
      * @param metadata.size - The size of the file
      * @param metadata.mimeType - The mime type of the file
      * @param metadata.parentId - The ID of the parent file for hierarchical file relationships
+     * @param metadata.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param metadata.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -216,6 +220,8 @@ declare class VaultFile {
      * @param params.mimeType - The MIME type of the file (optional)
      * @param params.upload - Whether to upload the file (default: false)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -274,6 +280,8 @@ declare class VaultFile {
         mimeType?: string;
         upload?: boolean;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;
@@ -287,6 +295,8 @@ declare class VaultFile {
      * @param params.config - The configuration for the VaultFile
      * @param params.contentType - The MIME type of the content (optional)
      * @param params.parentId - The ID of the parent file for hierarchical file relationships
+     * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+     * @param params.onParentConflict - What to do if the file already exists as an active child of another file
      * @param options - The options for the request
      * @param options.signal - The signal to abort the request
      *
@@ -328,6 +338,8 @@ declare class VaultFile {
         config: VaultConfig;
         contentType?: string;
         parentId?: string;
+        onMissingParent?: OnMissingParent;
+        onParentConflict?: OnParentConflict;
     }, options?: {
         signal?: AbortSignal;
     }): Promise<VaultFile>;

package/dist/index.mjs

@@ -231,7 +231,7 @@ function getFileName(content) {
 }
 
 const name = "@meistrari/vault-sdk";
-const version = "1.8.2";
+const version = "1.9.0";
 const license = "UNLICENSED";
 const repository = {
 	type: "git",
@@ -293,6 +293,9 @@ const packageJson = {
 	publishConfig: publishConfig
 };
 
+const serviceName = typeof process !== "undefined" ? process?.env?.SERVICE_NAME : "";
+const userAgent = `vault-js-sdk:${packageJson.version}${serviceName ? `@${serviceName}` : ""}`.trim();
+
 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) => {
@@ -316,7 +319,7 @@ async function wrappedFetch(url, requestInit) {
     duplex: requestInit.body instanceof ReadableStream ? "half" : void 0
   };
   const request = new Request(url, options);
-  request.headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+  request.headers.set("User-Agent", userAgent);
   const response = await fetch(request);
   if (!response.ok) {
     throw await FetchError.from(request.url, request.method, response);
@@ -361,7 +364,7 @@ class VaultFile {
    */
   get headers() {
     const headers = this.config.authStrategy.getHeaders();
-    headers.set("User-Agent", `vault-js-sdk:${packageJson.version}`);
+    headers.set("User-Agent", userAgent);
     return headers;
   }
   /**
@@ -407,6 +410,8 @@ class VaultFile {
    * @param metadata.size - The size of the file
    * @param metadata.mimeType - The mime type of the file
    * @param metadata.parentId - The ID of the parent file for hierarchical file relationships
+   * @param metadata.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param metadata.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -422,6 +427,8 @@ class VaultFile {
         size: metadata.size,
         mimeType: metadata.mimeType,
         parentId: metadata.parentId,
+        onMissingParent: metadata.onMissingParent,
+        onParentConflict: metadata.onParentConflict,
         fileName: this.name,
         sha256sum: this.id ?? this.metadata?.id ?? (this.content ? await getFileHash(this.content) : void 0)
       }),
@@ -512,6 +519,8 @@ class VaultFile {
    * @param params.mimeType - The MIME type of the file (optional)
    * @param params.upload - Whether to upload the file (default: false)
    * @param params.parentId - The ID of the parent file for hierarchical file relationships
+   * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param params.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -564,7 +573,7 @@ class VaultFile {
    * ```
    */
   static async fromContent(params, options) {
-    const { content, config: vaultConfig, upload = false, parentId } = params;
+    const { content, config: vaultConfig, upload = false, parentId, onMissingParent, onParentConflict } = params;
     const name = basename(params.name) ?? getFileName(content);
     const config = resolveConfig(vaultConfig);
     const { vaultUrl, authStrategy } = config;
@@ -583,7 +592,9 @@ class VaultFile {
     const createdFile = await file._createFile({
       size,
       mimeType,
-      parentId
+      parentId,
+      onMissingParent,
+      onParentConflict
     }, { signal: options?.signal });
     if (upload) {
       await file.upload(file.content, createdFile.uploadUrl, { signal: options?.signal });
@@ -600,6 +611,8 @@ class VaultFile {
    * @param params.config - The configuration for the VaultFile
    * @param params.contentType - The MIME type of the content (optional)
    * @param params.parentId - The ID of the parent file for hierarchical file relationships
+   * @param params.onMissingParent - What to do if the parent file does not exist or has been deleted
+   * @param params.onParentConflict - What to do if the file already exists as an active child of another file
    * @param options - The options for the request
    * @param options.signal - The signal to abort the request
    *
@@ -636,14 +649,23 @@ class VaultFile {
    * ```
    */
   static async fromStream(params, options) {
-    const { contentLength, config: vaultConfig, contentType, parentId } = params;
+    const {
+      contentLength,
+      config: vaultConfig,
+      contentType,
+      parentId,
+      onMissingParent,
+      onParentConflict
+    } = params;
     const name = basename(params.name);
     const config = resolveConfig(vaultConfig);
     const file = new VaultFile({ config, name });
     await file._createFile({
       size: contentLength,
       mimeType: contentType || "application/octet-stream",
-      parentId
+      parentId,
+      onMissingParent,
+      onParentConflict
     }, { signal: options?.signal });
     return file;
   }

package/package.json

@@ -1,49 +1,49 @@
 {
-    "name": "@meistrari/vault-sdk",
-    "version": "1.8.2",
-    "license": "UNLICENSED",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/meistrari/vault.git"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.cjs"
-        }
-    },
-    "main": "dist/index.mjs",
-    "types": "dist/index.d.ts",
-    "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.7",
-        "@meistrari/file-type": "22.0.0",
-        "mime-types": "3.0.1",
-        "ofetch": "1.4.1",
-        "zod": "3.23.8"
-    },
-    "devDependencies": {
-        "@types/bun": "latest",
-        "@types/mime-types": "3.0.1",
-        "msw": "2.6.8",
-        "unbuild": "2.0.0",
-        "vitest": "2.1.9"
-    },
-    "peerDependencies": {
-        "typescript": "^5.0.0"
-    },
-    "publishConfig": {
-        "access": "public"
+  "name": "@meistrari/vault-sdk",
+  "version": "1.9.0",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/meistrari/vault.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
-}
+  },
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "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.7",
+    "@meistrari/file-type": "22.0.0",
+    "mime-types": "3.0.1",
+    "ofetch": "1.4.1",
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/mime-types": "3.0.1",
+    "msw": "2.6.8",
+    "unbuild": "2.0.0",
+    "vitest": "2.1.9"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}