@meistrari/vault-http-client 2.9.0 → 2.14.1

package/dist/index.cjs

@@ -3,31 +3,30 @@
 const core = require('@zodios/core');
 const zod = require('zod');
 
-const postFilesBulk_Body = zod.z.union([
-  zod.z.array(
-    zod.z.object({
-      fileName: zod.z.string(),
-      parentId: zod.z.string(),
-      onMissingParent: zod.z.enum(["error", "create-as-root"]).default("error"),
-      sha256sum: zod.z.string(),
-      size: zod.z.number(),
-      mimeType: zod.z.string(),
-      createdBy: zod.z.string(),
-      path: zod.z.string()
-    }).partial()
-  ),
-  zod.z.object({ files: zod.z.array(zod.z.string()) })
-]);
 const postFiles_Body = zod.z.object({
   fileName: zod.z.string(),
   parentId: zod.z.string(),
   onMissingParent: zod.z.enum(["error", "create-as-root"]).default("error"),
+  onParentConflict: zod.z.enum(["error", "update-parent-id", "ignore"]).default("error"),
   sha256sum: zod.z.string(),
   size: zod.z.number(),
   mimeType: zod.z.string(),
   createdBy: zod.z.string(),
   path: zod.z.string()
 }).partial();
+const postFilesBulk_Body = zod.z.array(
+  zod.z.object({
+    fileName: zod.z.string(),
+    parentId: zod.z.string(),
+    onMissingParent: zod.z.enum(["error", "create-as-root"]).default("error"),
+    onParentConflict: zod.z.enum(["error", "update-parent-id", "ignore"]).default("error"),
+    sha256sum: zod.z.string(),
+    size: zod.z.number(),
+    mimeType: zod.z.string(),
+    createdBy: zod.z.string(),
+    path: zod.z.string()
+  }).partial()
+);
 const put_WorkspacesByWorkspaceIdSettings_Body = zod.z.object({
   bucketName: zod.z.string().min(1),
   keyArns: zod.z.array(zod.z.string()).min(1),
@@ -406,7 +405,6 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     response: zod.z.array(
       zod.z.object({
         workspaceId: zod.z.string(),
-        files: zod.z.number(),
         permalinks: zod.z.number(),
         hasCustomSettings: zod.z.boolean()
       })
@@ -572,6 +570,71 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
       path: zod.z.string()
     })
   },
+  {
+    method: "get",
+    path: "/files",
+    description: `Get a list of files.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "limit",
+        type: "Query",
+        schema: zod.z.number().gte(1).lte(500).optional().default(10)
+      },
+      {
+        name: "offset",
+        type: "Query",
+        schema: zod.z.number().gte(0).optional().default(0)
+      },
+      {
+        name: "orderByField",
+        type: "Query",
+        schema: zod.z.enum(["id", "createdAt", "deletedAt"]).optional()
+      },
+      {
+        name: "orderByDirection",
+        type: "Query",
+        schema: zod.z.enum(["asc", "desc"]).optional().default("asc")
+      },
+      {
+        name: "search",
+        type: "Query",
+        schema: zod.z.string().optional()
+      },
+      {
+        name: "includeDeleted",
+        type: "Query",
+        schema: zod.z.enum(["true", "false"]).optional().default("false")
+      },
+      {
+        name: "includeChildren",
+        type: "Query",
+        schema: zod.z.enum(["true", "false"]).optional().default("false")
+      }
+    ],
+    response: zod.z.object({
+      files: zod.z.array(
+        zod.z.object({
+          id: zod.z.string(),
+          path: zod.z.string(),
+          workspaceId: zod.z.string(),
+          parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
+          legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          createdAt: zod.z.string(),
+          deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+          uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
+        })
+      ),
+      count: zod.z.number(),
+      pages: zod.z.number()
+    })
+  },
   {
     method: "get",
     path: "/files/:fileId",
@@ -620,6 +683,40 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
       }
     ]
   },
+  {
+    method: "patch",
+    path: "/files/:fileId",
+    description: `Update file metadata. This only affects file metadata and has no effect on file conflicts or storage location.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "body",
+        type: "Body",
+        schema: zod.z.object({ name: zod.z.string().min(1) })
+      },
+      {
+        name: "fileId",
+        type: "Path",
+        schema: zod.z.string()
+      }
+    ],
+    response: zod.z.object({
+      id: zod.z.string(),
+      path: zod.z.string(),
+      workspaceId: zod.z.string(),
+      parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
+      legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      createdAt: zod.z.string(),
+      deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
+      uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
+    })
+  },
   {
     method: "post",
     path: "/files/:fileId/permalinks",
@@ -867,9 +964,12 @@ The returned `url` is valid for 1 hour by default. You can change the
         schema: postFilesBulk_Body
       }
     ],
-    response: zod.z.union([
-      zod.z.array(
-        zod.z.object({
+    response: zod.z.array(
+      zod.z.object({
+        id: zod.z.string(),
+        uploadUrl: zod.z.string(),
+        expiresAt: zod.z.string().datetime({ offset: true }),
+        metadata: zod.z.object({
           id: zod.z.string(),
           path: zod.z.string(),
           workspaceId: zod.z.string(),
@@ -884,29 +984,10 @@ The returned `url` is valid for 1 hour by default. You can change the
           createdAt: zod.z.string(),
           deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
           uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-        })
-      ),
-      zod.z.object({
-        files: zod.z.array(
-          zod.z.object({
-            id: zod.z.string(),
-            path: zod.z.string(),
-            workspaceId: zod.z.string(),
-            parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-            legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            createdAt: zod.z.string(),
-            deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-          })
-        )
+        }),
+        path: zod.z.string()
       })
-    ])
+    )
   },
   {
     method: "get",
@@ -978,349 +1059,6 @@ Make sure to follow redirects to the actual file download URL.
         schema: zod.z.void()
       }
     ]
-  },
-  {
-    method: "patch",
-    path: "/v2/:id/uploaded-at",
-    description: `Set the uploaded at timestamp for a file.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "id",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.void()
-  },
-  {
-    method: "post",
-    path: "/v2/files",
-    description: `Create a file and get a pre-signed upload URL.
-
-The `sha256` body param is used as the file's primary key. If not provided, a random UUID will be generated.
-
-The returned `uploadUrl` is valid for 1 hour by default. You can change the expiration time by passing the `expiresIn` query parameter.
-`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "body",
-        type: "Body",
-        schema: postFiles_Body
-      },
-      {
-        name: "expiresIn",
-        type: "Query",
-        schema: zod.z.number().optional().default(3600)
-      }
-    ],
-    response: zod.z.object({
-      id: zod.z.string(),
-      uploadUrl: zod.z.string(),
-      expiresAt: zod.z.string().datetime({ offset: true }),
-      metadata: zod.z.object({
-        id: zod.z.string(),
-        path: zod.z.string(),
-        workspaceId: zod.z.string(),
-        parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-        legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        createdAt: zod.z.string(),
-        deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-        uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-      }),
-      path: zod.z.string()
-    })
-  },
-  {
-    method: "get",
-    path: "/v2/files/:fileId",
-    description: `Get a pre-signed download URL for a file.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "preserveFileName",
-        type: "Query",
-        schema: zod.z.enum(["true", "false"]).optional().default("true")
-      },
-      {
-        name: "fileId",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.object({
-      url: zod.z.string(),
-      expiresAt: zod.z.string().datetime({ offset: true }),
-      metadata: zod.z.union([
-        zod.z.object({
-          id: zod.z.string(),
-          path: zod.z.string(),
-          workspaceId: zod.z.string(),
-          parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-          legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdAt: zod.z.string(),
-          deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-        }),
-        zod.z.null()
-      ])
-    }),
-    errors: [
-      {
-        status: 404,
-        description: `File not found`,
-        schema: zod.z.void()
-      }
-    ]
-  },
-  {
-    method: "post",
-    path: "/v2/files/:filename",
-    description: `Create a file and get a pre-signed upload URL (legacy endpoint).
-
-This endpoint is deprecated. Use POST /files instead with `originalFileName` in the request body.
-
-The `sha256` body param is used as the file's primary key. If not provided, a random UUID will be generated.
-
-The returned `url` is valid for 1 hour by default. You can change the expiration time by passing the `expiresIn` query parameter.
-`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "body",
-        type: "Body",
-        schema: postFiles_Body
-      },
-      {
-        name: "expiresIn",
-        type: "Query",
-        schema: zod.z.number().optional().default(3600)
-      },
-      {
-        name: "filename",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.object({
-      url: zod.z.string(),
-      expiresAt: zod.z.string().datetime({ offset: true })
-    })
-  },
-  {
-    method: "put",
-    path: "/v2/files/:id",
-    description: `Create a file and get a pre-signed upload URL.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "expiresIn",
-        type: "Query",
-        schema: zod.z.number().optional().default(3600)
-      },
-      {
-        name: "id",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.union([
-      zod.z.object({
-        id: zod.z.string(),
-        uploadUrl: zod.z.string().url(),
-        expiresAt: zod.z.string().datetime({ offset: true }),
-        metadata: zod.z.object({
-          id: zod.z.string(),
-          path: zod.z.string(),
-          workspaceId: zod.z.string(),
-          parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-          legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdAt: zod.z.string(),
-          deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-        })
-      }),
-      zod.z.object({
-        url: zod.z.string().url(),
-        expiresAt: zod.z.string().datetime({ offset: true })
-      })
-    ])
-  },
-  {
-    method: "delete",
-    path: "/v2/files/:id",
-    description: `Delete a file.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "id",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.void()
-  },
-  {
-    method: "get",
-    path: "/v2/files/:id/metadata",
-    description: `Get the metadata for a file.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "id",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.object({
-      id: zod.z.string(),
-      path: zod.z.string(),
-      workspaceId: zod.z.string(),
-      parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-      legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      createdAt: zod.z.string(),
-      deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-      uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-    }),
-    errors: [
-      {
-        status: 404,
-        description: `File not found`,
-        schema: zod.z.void()
-      }
-    ]
-  },
-  {
-    method: "get",
-    path: "/v2/files/:parentId/children",
-    description: `Get the children of a file.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "mimeType",
-        type: "Query",
-        schema: zod.z.string().optional()
-      },
-      {
-        name: "includeDeleted",
-        type: "Query",
-        schema: zod.z.enum(["true", "false"]).optional().default("false")
-      },
-      {
-        name: "limit",
-        type: "Query",
-        schema: zod.z.number().optional().default(100)
-      },
-      {
-        name: "offset",
-        type: "Query",
-        schema: zod.z.number().optional().default(0)
-      },
-      {
-        name: "parentId",
-        type: "Path",
-        schema: zod.z.string()
-      }
-    ],
-    response: zod.z.object({
-      files: zod.z.array(
-        zod.z.object({
-          id: zod.z.string(),
-          path: zod.z.string(),
-          workspaceId: zod.z.string(),
-          parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-          legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdAt: zod.z.string(),
-          deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-        })
-      ),
-      count: zod.z.number()
-    })
-  },
-  {
-    method: "post",
-    path: "/v2/files/bulk",
-    description: `Create multiple files in bulk and get pre-signed upload URLs.`,
-    requestFormat: "json",
-    parameters: [
-      {
-        name: "body",
-        type: "Body",
-        schema: postFilesBulk_Body
-      }
-    ],
-    response: zod.z.union([
-      zod.z.array(
-        zod.z.object({
-          id: zod.z.string(),
-          path: zod.z.string(),
-          workspaceId: zod.z.string(),
-          parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-          legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          createdAt: zod.z.string(),
-          deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-          uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-        })
-      ),
-      zod.z.object({
-        files: zod.z.array(
-          zod.z.object({
-            id: zod.z.string(),
-            path: zod.z.string(),
-            workspaceId: zod.z.string(),
-            parentId: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            originalFileName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            mimeType: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            size: zod.z.union([zod.z.number(), zod.z.null()]).optional(),
-            legacyKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            bucketName: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            encryptionKey: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            createdBy: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            createdAt: zod.z.string(),
-            deletedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional(),
-            uploadedAt: zod.z.union([zod.z.string(), zod.z.null()]).optional()
-          })
-        )
-      })
-    ])
   }
 ]);
 new core.Zodios(endpoints);
@@ -1328,17 +1066,22 @@ function createApiClient(baseUrl, options) {
   return new core.Zodios(baseUrl, endpoints, options);
 }
 
+const version = "2.14.0";
+const packageInfo = {
+	version: version};
+
+const serviceName = process.env.SERVICE_NAME;
+const userAgent = `vault-http-client:${packageInfo.version}${serviceName ? `@${serviceName}` : ""}`.trim();
 function useVaultClient(vaultUrl, token) {
   const api = createApiClient(vaultUrl, {
     axiosConfig: {
       headers: {
         "Authorization": token,
-        "User-Agent": "vault-http-client:2.9.0"
+        "User-Agent": userAgent
       }
     }
   });
   return api;
 }
 
-exports.createApiClient = createApiClient;
 exports.useVaultClient = useVaultClient;