@transloadit/zod 4.5.0 → 5.0.0

package/dist/v3/storageAsset.js

@@ -1,4 +1,5 @@
 import { z } from 'zod/v3';
+import { describeApiParameter, describeApiParameterFields } from "./apiParameterDescription.js";
 /** Maximum normalized Storage path length supported by the catalog schema. */
 export const damPathMaxCodePoints = 512;
 // A Unicode regexp counts code points and stays portable across the published Zod 3/4 schemas.
@@ -6,12 +7,9 @@ const boundedPathSchema = z.string().regex(new RegExp(`^[\\s\\S]{0,${damPathMaxC
 /** Canonical path and JSON representation of a 128-bit Storage identifier. */
 export const damIdPattern = /^[A-Za-z0-9_-]{21}[AQgw]$/u;
 /** Canonical public Storage asset, version and folder identifier. */
-export const damIdSchema = z
-    .string()
-    .regex(damIdPattern)
-    .describe('Case-sensitive, canonical 22-character Base64URL Storage identifier.');
+export const damIdSchema = describeApiParameter('damId', z.string().regex(damIdPattern), 'Case-sensitive, canonical 22-character Base64URL DAM identifier.');
 /** A retained version of a live Workspace asset, independent of its mutable location. */
-export const storedAssetSchema = z.object({
+export const storedAssetSchema = z.object(describeApiParameterFields('storedAsset', {
     workspace: z.string().min(1),
     asset_id: damIdSchema,
     version_id: damIdSchema,
@@ -31,18 +29,38 @@ export const storedAssetSchema = z.object({
     thumbhash: z
         .string()
         .regex(/^(?:[A-Za-z0-9+/]{4}){1,15}(?:[A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)$/u)
-        .optional()
-        .describe('Base64-encoded ThumbHash of this version’s displayed pixels, when requested with output_meta.thumbhash on its producing Step. This is image data: apply the same access controls as the original.'),
-    has_alpha: z.boolean().optional().describe('Whether the image has an alpha channel, even if all its pixels are opaque. Present when ThumbHash extraction succeeds; absence means unknown.'),
-});
+        .optional(),
+    has_alpha: z.boolean().optional(),
+}, {
+    workspace: 'Workspace slug that owns this asset. Authenticate for the same Workspace when reading or managing it.',
+    asset_id: 'Stable asset ID. It survives native moves and renames; use it without a version to select the current bytes.',
+    version_id: 'Exact immutable version of this asset. Pair with asset_id to select retained bytes; a missing version never falls back to the current version.',
+    path: 'Current mutable location relative to the Workspace. A rename makes the previous path stale; overwriting can change the bytes at this path.',
+    size: 'Size of the stored file in bytes.',
+    mime: 'MIME type of the stored bytes, or null when unknown.',
+    md5hash: 'Lowercase MD5 checksum of the stored bytes, when available.',
+    sha256: 'Lowercase SHA-256 checksum of the stored bytes, when available.',
+    width: 'Display width in pixels, after applying EXIF orientation, when known.',
+    height: 'Display height in pixels, after applying EXIF orientation, when known.',
+    thumbhash: 'Base64-encoded ThumbHash of this version’s displayed pixels, when requested with output_meta.thumbhash on its producing Step. This is image data: apply the same access controls as the original.',
+    has_alpha: 'Whether the image has an alpha channel, even if all its pixels are opaque. Present when ThumbHash extraction succeeds; absence means unknown.',
+}));
+/** Shared explanations for portable client options and normalized API request fields. */
+export const damAssetsListDescriptions = {
+    prefix: 'Only list current asset paths starting with this case-sensitive prefix. The empty default includes the whole Workspace; include a trailing slash to select a directory boundary.',
+    cursor: 'Opaque continuation value from next_cursor in the previous response. Keep the same prefix while paging. Omit for the first page.',
+    limit: 'Maximum number of assets per page. Defaults to 100 and accepts up to 500; follow next_cursor until null.',
+};
 /** Bounded metadata paging; cursors are the last returned, case-sensitive asset path. */
-export const damAssetsListOptionsSchema = z.object({
+export const damAssetsListOptionsSchema = z.object(describeApiParameterFields('storedAssetsList', {
     prefix: boundedPathSchema.default(''),
     cursor: boundedPathSchema.min(1).optional(),
     limit: z.number().int().min(1).max(500).default(100),
-});
+}, damAssetsListDescriptions));
 /** An omitted version selects the current version; an explicit version never falls back. */
-export const damAssetGetOptionsSchema = z.object({ version_id: damIdSchema.optional() });
+export const damAssetGetOptionsSchema = z.object({
+    version_id: describeApiParameter('storedAssetGetVersionId', damIdSchema.optional(), 'Optional retained version of the selected asset. Omit for the current version. A missing or deleted version returns an error and never falls back to current bytes.'),
+});
 /** Omit the destination to rename in place; null moves to the Workspace root. */
 export const damAssetMoveOptionsSchema = z.object({
     destination_folder_id: damIdSchema.nullable().optional(),

package/dist/v3/template.d.ts

@@ -341,7 +341,7 @@ export declare const templateListParamsSchema: z.ZodObject<{
     order: "asc" | "desc";
     fromdate: string;
     todate: string;
-    include_builtin?: "all" | "none" | "latest" | "exclusively-latest" | "exclusively-all" | undefined;
+    include_builtin?: "none" | "all" | "latest" | "exclusively-latest" | "exclusively-all" | undefined;
 }, {
     auth: {
         key: string;
@@ -359,7 +359,7 @@ export declare const templateListParamsSchema: z.ZodObject<{
     pagesize?: number | undefined;
     order?: "asc" | "desc" | undefined;
     todate?: string | undefined;
-    include_builtin?: "all" | "none" | "latest" | "exclusively-latest" | "exclusively-all" | undefined;
+    include_builtin?: "none" | "all" | "latest" | "exclusively-latest" | "exclusively-all" | undefined;
 }>;
 export declare const assemblyInstructionsWithHiddenSchema: z.ZodObject<{
     allow_steps_override: z.ZodOptional<z.ZodBoolean>;

package/dist/v3/templateCredential.d.ts

@@ -76,9 +76,9 @@ export declare const templateCredentialsSchema: z.ZodObject<{
     type: z.ZodEnum<["ai", "azure", "backblaze", "cloudflare", "companion", "digitalocean", "dropbox", "ftp", "google", "http", "mega", "minio", "rackspace", "s3", "sftp", "supabase", "swift", "tigris", "vimeo", "wasabi", "youtube"]>;
     content: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strict", z.ZodTypeAny, {
-    type: "http" | "cloudflare" | "ai" | "vimeo" | "azure" | "backblaze" | "companion" | "digitalocean" | "dropbox" | "ftp" | "google" | "mega" | "minio" | "rackspace" | "s3" | "sftp" | "supabase" | "swift" | "tigris" | "wasabi" | "youtube";
-    name: string;
+    type: "http" | "ai" | "vimeo" | "azure" | "backblaze" | "cloudflare" | "companion" | "digitalocean" | "dropbox" | "ftp" | "google" | "mega" | "minio" | "rackspace" | "s3" | "sftp" | "supabase" | "swift" | "tigris" | "wasabi" | "youtube";
     content: {};
+    name: string;
     auth: {
         key: string;
         secret?: string | undefined;
@@ -89,9 +89,9 @@ export declare const templateCredentialsSchema: z.ZodObject<{
         referer?: string | undefined;
     };
 }, {
-    type: "http" | "cloudflare" | "ai" | "vimeo" | "azure" | "backblaze" | "companion" | "digitalocean" | "dropbox" | "ftp" | "google" | "mega" | "minio" | "rackspace" | "s3" | "sftp" | "supabase" | "swift" | "tigris" | "wasabi" | "youtube";
-    name: string;
+    type: "http" | "ai" | "vimeo" | "azure" | "backblaze" | "cloudflare" | "companion" | "digitalocean" | "dropbox" | "ftp" | "google" | "mega" | "minio" | "rackspace" | "s3" | "sftp" | "supabase" | "swift" | "tigris" | "wasabi" | "youtube";
     content: {};
+    name: string;
     auth: {
         key: string;
         secret?: string | undefined;

package/dist/v3/utility.d.ts

@@ -0,0 +1,22 @@
+/** An array of an object's own enumerable entries with typed keys and values. */
+export type ObjectEntries<T extends object> = T extends Map<infer Key, infer Value> ? [Key, Value][] : T extends Set<infer Item> ? [Item, Item][] : T extends readonly unknown[] ? [number, T[number]][] : T extends object ? [keyof T, T[keyof T]][] : never;
+/** A value that may be returned directly or through a promise-like object. */
+export type Promisable<T> = T | PromiseLike<T>;
+type Simplify<T> = {
+    [Key in keyof T]: T[Key];
+} & {};
+type PickIndexSignature<T> = {
+    [Key in keyof T as {} extends Record<Key, unknown> ? Key : never]: T[Key];
+};
+type OmitIndexSignature<T> = {
+    [Key in keyof T as {} extends Record<Key, unknown> ? never : Key]: T[Key];
+};
+type SimpleMerge<Destination, Source> = {
+    [Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];
+} & Source;
+/** An object type formed by overwriting destination properties with source properties. */
+export type MergeObjects<Destination, Source> = Simplify<SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>> & SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>>;
+/** A string literal type with every search occurrence replaced. */
+export type StringReplaceAll<Input extends string, Search extends string, Replacement extends string, Accumulator extends string = ''> = Search extends string ? Search extends '' ? Input : Replacement extends string ? Input extends `${infer Head}${Search}${infer Tail}` ? StringReplaceAll<Tail, Search, Replacement, `${Accumulator}${Head}${Replacement}`> : `${Accumulator}${Input}` : never : never;
+export {};
+//# sourceMappingURL=utility.d.ts.map

package/dist/v3/utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../src/v3/utility.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IACxC,CAAC,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,MAAM,KAAK,CAAC,GACjC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,GACd,CAAC,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,GACvB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,GACd,CAAC,SAAS,SAAS,OAAO,EAAE,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GACrB,CAAC,SAAS,MAAM,GACd,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GACvB,KAAK,CAAA;AAEjB,8EAA8E;AAC9E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;AAE9C,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;CAAE,GAAG,EAAE,CAAA;AAEpD,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAE1B,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,SAAS,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC;CAC1E,CAAA;AAED,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAE1B,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,SAAS,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,KAAK,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;CAC1E,CAAA;AAED,KAAK,WAAW,CAAC,WAAW,EAAE,MAAM,IAAI;KACrC,GAAG,IAAI,MAAM,WAAW,IAAI,GAAG,SAAS,MAAM,MAAM,GAAG,KAAK,GAAG,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC;CACvF,GAAG,MAAM,CAAA;AAEV,0FAA0F;AAC1F,MAAM,MAAM,YAAY,CAAC,WAAW,EAAE,MAAM,IAAI,QAAQ,CACtD,WAAW,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,GACtE,WAAW,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAC3E,CAAA;AAED,mEAAmE;AACnE,MAAM,MAAM,gBAAgB,CAC1B,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,MAAM,EACrB,WAAW,SAAS,MAAM,EAC1B,WAAW,SAAS,MAAM,GAAG,EAAE,IAC7B,MAAM,SAAS,MAAM,GACrB,MAAM,SAAS,EAAE,GACf,KAAK,GACL,WAAW,SAAS,MAAM,GACxB,KAAK,SAAS,GAAG,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,IAAI,EAAE,GACjD,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,GAAG,IAAI,GAAG,WAAW,EAAE,CAAC,GAClF,GAAG,WAAW,GAAG,KAAK,EAAE,GAC1B,KAAK,GACT,KAAK,CAAA"}

package/dist/v3/utility.js

@@ -0,0 +1 @@
+export {};