@meistrari/vault-http-client 2.14.1 → 2.17.6

package/dist/index.mjs

@@ -1,6 +1,18 @@
 import { makeApi, Zodios } from '@zodios/core';
 import { z } from 'zod';
 
+const postAssets_Body = z.object({
+  assetClass: z.string().min(1).max(128).regex(/^[a-z0-9][a-z0-9._:-]*$/),
+  subject: z.string().min(1).max(255),
+  mimeType: z.enum([
+    "image/png",
+    "image/jpeg",
+    "image/gif",
+    "image/webp",
+    "image/avif"
+  ]),
+  size: z.number().int().gte(0).lte(9007199254740991).optional()
+});
 const postFiles_Body = z.object({
   fileName: z.string(),
   parentId: z.string(),
@@ -9,8 +21,7 @@ const postFiles_Body = z.object({
   sha256sum: z.string(),
   size: z.number(),
   mimeType: z.string(),
-  createdBy: z.string(),
-  path: z.string()
+  createdBy: z.string()
 }).partial();
 const postFilesBulk_Body = z.array(
   z.object({
@@ -21,11 +32,23 @@ const postFilesBulk_Body = z.array(
     sha256sum: z.string(),
     size: z.number(),
     mimeType: z.string(),
-    createdBy: z.string(),
-    path: z.string()
+    createdBy: z.string()
   }).partial()
 );
-const put_WorkspacesByWorkspaceIdSettings_Body = z.object({
+const postFilesByFileIdMultipartPart_Body = z.object({
+  uploadId: z.string().min(1).max(4096),
+  partNumber: z.number().int().gte(1).lte(1e4)
+});
+const postFilesByFileIdMultipartComplete_Body = z.object({
+  uploadId: z.string().min(1).max(4096),
+  parts: z.array(
+    z.object({
+      partNumber: z.number().int().gte(1).lte(1e4),
+      etag: z.string().min(1).max(256)
+    })
+  ).min(1).max(1e4)
+});
+const putWorkspacesByWorkspaceIdSettings_Body = z.object({
   bucketName: z.string().min(1),
   keyArns: z.array(z.string()).min(1),
   defaultS3LinkTtl: z.number().gte(1)
@@ -126,7 +149,9 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     response: z.object({
       id: z.string(),
       uploadUrl: z.string().url(),
-      expiresAt: z.string().datetime({ offset: true }),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
       metadata: z.object({
         id: z.string(),
         path: z.string(),
@@ -166,6 +191,16 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
         type: "Query",
         schema: z.enum(["true", "false"]).optional().default("false")
       },
+      {
+        name: "includeChildren",
+        type: "Query",
+        schema: z.enum(["true", "false"]).optional().default("false")
+      },
+      {
+        name: "includeParent",
+        type: "Query",
+        schema: z.enum(["true", "false"]).optional().default("false")
+      },
       {
         name: "fileId",
         type: "Path",
@@ -174,7 +209,9 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     ],
     response: z.object({
       url: z.string(),
-      expiresAt: z.string().datetime({ offset: true }),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
       metadata: z.union([
         z.object({
           id: z.string(),
@@ -208,7 +245,7 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
               deletedAt: z.union([z.string(), z.null()]).optional(),
               uploadedAt: z.union([z.string(), z.null()]).optional()
             })
-          ),
+          ).optional(),
           parent: z.union([
             z.object({
               id: z.string(),
@@ -227,7 +264,7 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
               uploadedAt: z.union([z.string(), z.null()]).optional()
             }),
             z.null()
-          ])
+          ]).optional()
         }),
         z.null()
       ])
@@ -316,7 +353,9 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     response: z.object({
       id: z.string(),
       uploadUrl: z.string().url(),
-      expiresAt: z.string().datetime({ offset: true }),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
       metadata: z.object({
         id: z.string(),
         path: z.string(),
@@ -474,7 +513,7 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
       {
         name: "body",
         type: "Body",
-        schema: put_WorkspacesByWorkspaceIdSettings_Body
+        schema: putWorkspacesByWorkspaceIdSettings_Body
       },
       {
         name: "workspaceId",
@@ -523,6 +562,86 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     ],
     response: z.void()
   },
+  {
+    method: "post",
+    path: "/assets",
+    description: `Create an asset and get a pre-signed upload URL for the dedicated assets bucket.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "body",
+        type: "Body",
+        schema: postAssets_Body
+      },
+      {
+        name: "expiresIn",
+        type: "Query",
+        schema: z.number().optional().default(3600)
+      }
+    ],
+    response: z.object({
+      assetId: z.string(),
+      assetUrl: z.string().url(),
+      uploadUrl: z.string().url(),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
+      uploadHeaders: z.object({
+        "cache-control": z.string(),
+        "content-disposition": z.string(),
+        "content-type": z.string(),
+        "if-none-match": z.string()
+      }),
+      asset: z.object({
+        id: z.string(),
+        path: z.string(),
+        assetUrl: z.string().url(),
+        assetClass: z.string(),
+        subject: z.string(),
+        mimeType: z.string(),
+        size: z.union([z.number(), z.null()]).optional(),
+        bucketName: z.union([z.string(), z.null()]).optional(),
+        createdBy: z.union([z.string(), z.null()]).optional(),
+        createdAt: z.string(),
+        uploadedAt: z.union([z.string(), z.null()]).optional(),
+        deletedAt: z.union([z.string(), z.null()]).optional()
+      })
+    })
+  },
+  {
+    method: "get",
+    path: "/assets/:assetId",
+    description: `Get a stored asset by ID, including its stable CloudFront URL.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "assetId",
+        type: "Path",
+        schema: z.string()
+      }
+    ],
+    response: z.object({
+      id: z.string(),
+      path: z.string(),
+      assetUrl: z.string().url(),
+      assetClass: z.string(),
+      subject: z.string(),
+      mimeType: z.string(),
+      size: z.union([z.number(), z.null()]).optional(),
+      bucketName: z.union([z.string(), z.null()]).optional(),
+      createdBy: z.union([z.string(), z.null()]).optional(),
+      createdAt: z.string(),
+      uploadedAt: z.union([z.string(), z.null()]).optional(),
+      deletedAt: z.union([z.string(), z.null()]).optional()
+    }),
+    errors: [
+      {
+        status: 404,
+        description: `Asset not found`,
+        schema: z.void()
+      }
+    ]
+  },
   {
     method: "post",
     path: "/files",
@@ -548,7 +667,9 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     response: z.object({
       id: z.string(),
       uploadUrl: z.string(),
-      expiresAt: z.string().datetime({ offset: true }),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
       metadata: z.object({
         id: z.string(),
         path: z.string(),
@@ -652,7 +773,9 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
     ],
     response: z.object({
       url: z.string(),
-      expiresAt: z.string().datetime({ offset: true }),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
       metadata: z.union([
         z.object({
           id: z.string(),
@@ -715,6 +838,87 @@ The returned `uploadUrl` is valid for 1 hour by default. You can chang
       uploadedAt: z.union([z.string(), z.null()]).optional()
     })
   },
+  {
+    method: "post",
+    path: "/files/:fileId/multipart",
+    description: `Initiate a multipart upload for a file.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "fileId",
+        type: "Path",
+        schema: z.string()
+      }
+    ],
+    response: z.object({ uploadId: z.string().min(1) })
+  },
+  {
+    method: "delete",
+    path: "/files/:fileId/multipart",
+    description: `Abort a multipart upload and discard its uploaded parts.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "uploadId",
+        type: "Query",
+        schema: z.string().min(1).max(4096)
+      },
+      {
+        name: "fileId",
+        type: "Path",
+        schema: z.string()
+      }
+    ],
+    response: z.void()
+  },
+  {
+    method: "post",
+    path: "/files/:fileId/multipart/complete",
+    description: `Complete a multipart upload and assemble the file in S3.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "body",
+        type: "Body",
+        schema: postFilesByFileIdMultipartComplete_Body
+      },
+      {
+        name: "fileId",
+        type: "Path",
+        schema: z.string()
+      }
+    ],
+    response: z.void()
+  },
+  {
+    method: "post",
+    path: "/files/:fileId/multipart/part",
+    description: `Get a pre-signed URL for one multipart upload part.`,
+    requestFormat: "json",
+    parameters: [
+      {
+        name: "body",
+        type: "Body",
+        schema: postFilesByFileIdMultipartPart_Body
+      },
+      {
+        name: "expiresIn",
+        type: "Query",
+        schema: z.number().optional().default(3600)
+      },
+      {
+        name: "fileId",
+        type: "Path",
+        schema: z.string()
+      }
+    ],
+    response: z.object({
+      uploadUrl: z.string().url(),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true })
+    })
+  },
   {
     method: "post",
     path: "/files/:fileId/permalinks",
@@ -727,7 +931,11 @@ The returned permalink ID should be used with the `/permalinks/:permalinkId
       {
         name: "body",
         type: "Body",
-        schema: z.object({ expiresAt: z.string().datetime({ offset: true }) }).partial()
+        schema: z.object({
+          expiresAt: z.string().regex(
+            /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+          ).datetime({ offset: true })
+        }).partial()
       },
       {
         name: "fileId",
@@ -739,7 +947,7 @@ The returned permalink ID should be used with the `/permalinks/:permalinkId
       id: z.string(),
       fileId: z.string(),
       workspaceId: z.string(),
-      createdAt: z.string(),
+      createdAt: z.string().datetime({ offset: true }),
       expiresAt: z.union([z.string(), z.null()]),
       createdBy: z.union([z.string(), z.null()])
     })
@@ -761,46 +969,12 @@ The returned permalink ID should be used with the `/permalinks/:permalinkId
         id: z.string(),
         fileId: z.string(),
         workspaceId: z.string(),
-        createdAt: z.string(),
+        createdAt: z.string().datetime({ offset: true }),
         expiresAt: z.union([z.string(), z.null()]),
         createdBy: z.union([z.string(), z.null()])
       })
     )
   },
-  {
-    method: "post",
-    path: "/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: z.number().optional().default(3600)
-      },
-      {
-        name: "filename",
-        type: "Path",
-        schema: z.string()
-      }
-    ],
-    response: z.object({
-      url: z.string(),
-      expiresAt: z.string().datetime({ offset: true })
-    })
-  },
   {
     method: "put",
     path: "/files/:id",
@@ -818,33 +992,29 @@ The returned `url` is valid for 1 hour by default. You can change the
         schema: z.string()
       }
     ],
-    response: z.union([
-      z.object({
+    response: z.object({
+      id: z.string(),
+      uploadUrl: z.string().url(),
+      expiresAt: z.string().regex(
+        /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+      ).datetime({ offset: true }),
+      metadata: z.object({
         id: z.string(),
-        uploadUrl: z.string().url(),
-        expiresAt: z.string().datetime({ offset: true }),
-        metadata: z.object({
-          id: z.string(),
-          path: z.string(),
-          workspaceId: z.string(),
-          parentId: z.union([z.string(), z.null()]).optional(),
-          originalFileName: z.union([z.string(), z.null()]).optional(),
-          mimeType: z.union([z.string(), z.null()]).optional(),
-          size: z.union([z.number(), z.null()]).optional(),
-          legacyKey: z.union([z.string(), z.null()]).optional(),
-          bucketName: z.union([z.string(), z.null()]).optional(),
-          encryptionKey: z.union([z.string(), z.null()]).optional(),
-          createdBy: z.union([z.string(), z.null()]).optional(),
-          createdAt: z.string(),
-          deletedAt: z.union([z.string(), z.null()]).optional(),
-          uploadedAt: z.union([z.string(), z.null()]).optional()
-        })
-      }),
-      z.object({
-        url: z.string().url(),
-        expiresAt: z.string().datetime({ offset: true })
+        path: z.string(),
+        workspaceId: z.string(),
+        parentId: z.union([z.string(), z.null()]).optional(),
+        originalFileName: z.union([z.string(), z.null()]).optional(),
+        mimeType: z.union([z.string(), z.null()]).optional(),
+        size: z.union([z.number(), z.null()]).optional(),
+        legacyKey: z.union([z.string(), z.null()]).optional(),
+        bucketName: z.union([z.string(), z.null()]).optional(),
+        encryptionKey: z.union([z.string(), z.null()]).optional(),
+        createdBy: z.union([z.string(), z.null()]).optional(),
+        createdAt: z.string(),
+        deletedAt: z.union([z.string(), z.null()]).optional(),
+        uploadedAt: z.union([z.string(), z.null()]).optional()
       })
-    ])
+    })
   },
   {
     method: "delete",
@@ -966,7 +1136,9 @@ The returned `url` is valid for 1 hour by default. You can change the
       z.object({
         id: z.string(),
         uploadUrl: z.string(),
-        expiresAt: z.string().datetime({ offset: true }),
+        expiresAt: z.string().regex(
+          /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
+        ).datetime({ offset: true }),
         metadata: z.object({
           id: z.string(),
           path: z.string(),
@@ -1046,7 +1218,7 @@ Make sure to follow redirects to the actual file download URL.
       id: z.string(),
       fileId: z.string(),
       workspaceId: z.string(),
-      createdAt: z.string(),
+      createdAt: z.string().datetime({ offset: true }),
       expiresAt: z.union([z.string(), z.null()]),
       createdBy: z.union([z.string(), z.null()])
     }),
@@ -1064,7 +1236,7 @@ function createApiClient(baseUrl, options) {
   return new Zodios(baseUrl, endpoints, options);
 }
 
-const version = "2.14.0";
+const version = "2.17.6";
 const packageInfo = {
 	version: version};
 

package/package.json

@@ -1,26 +1,27 @@
 {
-    "name": "@meistrari/vault-http-client",
-    "version": "2.14.1",
-    "scripts": {
-        "build": "unbuild"
-    },
-    "types": "dist/index.d.ts",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "default": "./dist/index.mjs",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.cjs"
-        }
-    },
-    "files": [
-        "dist"
-    ],
-    "dependencies": {
-        "@zodios/core": "10.9.6",
-        "zod": "3.25.76"
-    },
-    "devDependencies": {
-        "unbuild": "3.6.1"
+  "name": "@meistrari/vault-http-client",
+  "version": "2.17.6",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/meistrari/vault.git"
+  },
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
     }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@zodios/core": "10.9.6",
+    "zod": "3.25.76"
+  },
+  "devDependencies": {
+    "unbuild": "3.6.1"
+  }
 }