@transloadit/zod 4.5.0 → 5.0.0

package/dist/v4/template.js

@@ -1,3 +1,4 @@
+import { optionalWithV3Semantics } from "./lib/sdkZodOptional.js";
 import { z } from 'zod/v4';
 import { robotsSchema, robotsWithHiddenBotsAndFieldsSchema, } from "./robots/_index.js";
 import { refineTransloaditImportSelector } from "./robots/transloadit-import.js";
@@ -12,7 +13,7 @@ export const stepSchema = z
     .superRefine(refineTransloaditImportSelector);
 export const stepsSchema = z.record(z.string(), stepSchema)
     .describe('Contains Assembly Instructions.');
-export const optionalStepsSchema = stepsSchema.optional();
+export const optionalStepsSchema = optionalWithV3Semantics(stepsSchema);
 export const stepSchemaWithHiddenFields = z
     .object({
     // This is a hack to get nicer robot hover messages in editors.
@@ -24,13 +25,11 @@ export const stepSchemaWithHiddenFields = z
     .superRefine(refineTransloaditImportSelector);
 export const stepsSchemaWithHiddenFields = z.record(z.string(), stepSchemaWithHiddenFields)
     .describe('Contains Assembly Instructions.');
-const optionalStepsWithHiddenFieldsSchema = stepsSchemaWithHiddenFields.optional();
-export const fieldsSchema = z.record(z.string(), z.any())
-    .optional()
+const optionalStepsWithHiddenFieldsSchema = optionalWithV3Semantics(stepsSchemaWithHiddenFields);
+export const fieldsSchema = optionalWithV3Semantics(z.record(z.string(), z.any()))
     .describe('An object of string keyed values (name -> value) that can be used as Assembly Variables, just like additional form fields can. You can use anything that is JSON stringifyable as a value');
-export const notifyUrlSchema = z
-    .string()
-    .optional()
+export const notifyUrlSchema = optionalWithV3Semantics(z
+    .string())
     .nullable()
     .describe("Transloadit can send a Pingback to your server when the Assembly is completed. We'll send the Assembly status in a form url-encoded JSON string inside of a transloadit field in a multipart POST request to the URL supplied here. Use `notification_payload` to reduce the payload size (e.g. `without_uploads`, `without_results`); the same filtering applies to notification replays.");
 export const notificationPayloadFilterValues = [
@@ -39,33 +38,28 @@ export const notificationPayloadFilterValues = [
     'without_upload_meta_data',
     'without_uploads',
 ];
-export const notificationPayloadSchema = z
-    .array(z.enum(notificationPayloadFilterValues))
-    .optional()
+export const notificationPayloadSchema = optionalWithV3Semantics(z
+    .array(z.enum(notificationPayloadFilterValues)))
     .describe('Controls the size of the payload sent in Assembly notifications (both the initial notification and any notification replays). An empty array (default) sends the complete Assembly status. Add `"without_upload_meta_data"` to strip `meta` from files in `uploads`. Add `"without_result_meta_data"` to strip `meta` from files in `results`. Add `"without_uploads"` to strip `uploads` entirely. Add `"without_results"` to strip `results` entirely. Filtering is applied before serialization, so using these options reduces memory use and helps avoid oversized-payload or OOM failures on large assemblies.');
-export const templateIdSchema = z
-    .string()
-    .optional()
+export const templateIdSchema = optionalWithV3Semantics(z
+    .string())
     .describe('The ID of the Template that contains your Assembly Instructions. If you set `allow_steps_override` to `false` in your Template, then `steps` and `template_id` will be mutually exclusive — you may supply only one of these parameters.');
 export const assemblyAuthInstructionsSchema = z
     .object({
     key: z.string().describe('Transloadit API key used to authenticate requests'),
-    secret: z.string().optional().describe('Transloadit API secret used to sign requests'),
-    expires: z
-        .string()
-        .optional()
+    secret: optionalWithV3Semantics(z.string()).describe('Transloadit API secret used to sign requests'),
+    expires: optionalWithV3Semantics(z
+        .string())
         .describe('ISO 8601 expiration timestamp for signature authentication'),
-    max_size: z.number().optional().describe('Maximum allowed upload size in bytes'),
-    max_number_of_files: z
+    max_size: optionalWithV3Semantics(z.number()).describe('Maximum allowed upload size in bytes'),
+    max_number_of_files: optionalWithV3Semantics(z
         .number()
         .int()
-        .min(1)
-        .optional()
+        .min(1))
         .describe('Maximum number of input files allowed per Assembly. If the number of uploaded or imported files exceeds this limit, the Assembly will be stopped with an error. This is useful for preventing abuse when Signature Authentication credentials are exposed.'),
-    nonce: z.string().optional().describe('Unique, random nonce for this request'),
-    referer: z
-        .string()
-        .optional()
+    nonce: optionalWithV3Semantics(z.string()).describe('Unique, random nonce for this request'),
+    referer: optionalWithV3Semantics(z
+        .string())
         .describe('Regular expression matched against the HTTP Referer to restrict upload origin'),
 })
     .describe(`Contains at least your Transloadit Auth Key in the \`key\` property.
@@ -101,23 +95,21 @@ The \`max_number_of_files\` property can be used to set a maximum number of file
 These properties can be set as part of the Assembly request or as part of the Template.
 `);
 const assemblyInstructionsSharedShape = {
-    allow_steps_override: z
-        .boolean()
-        .optional()
+    allow_steps_override: optionalWithV3Semantics(z
+        .boolean())
         .describe('Set this to false to disallow Overruling Templates at Runtime. If you set this to false then template_id and steps will be mutually exclusive and you may only supply one of those parameters. Recommended when deploying Transloadit in untrusted environments. This makes sense to set as part of a Template, rather than on the Assembly itself when creating it.'),
     notify_url: notifyUrlSchema,
     notification_payload: notificationPayloadSchema,
     fields: fieldsSchema,
-    quiet: z
-        .boolean()
-        .optional()
+    quiet: optionalWithV3Semantics(z
+        .boolean())
         .describe('Set this to true to reduce the response from an Assembly POST request to only the necessary fields. This prevents any potentially confidential information being leaked to the end user who is making the Assembly request. A successful Assembly will only include the ok and assembly_id fields. An erroneous Assembly will only include the error, http_code, message and assembly_id fields. The full Assembly Status will then still be sent to the notify_url if one was specified.'),
     // This is done to avoid heavy inference cost
     steps: optionalStepsSchema,
     template_id: templateIdSchema,
 };
 export const assemblyInstructionsSchema = z.object({
-    auth: assemblyAuthInstructionsSchema.optional(),
+    auth: optionalWithV3Semantics(assemblyAuthInstructionsSchema),
     ...assemblyInstructionsSharedShape,
 });
 export const assemblyInstructionsSchemaWithRequiredAuth = z.object({
@@ -188,9 +180,8 @@ export const templateListParamsSchema = z
         .array(z.string())
         .default([])
         .describe('Specifies keywords to be matched in the Assembly Status. The Assembly fields checked include the `id`, `redirect_url`, `fields`, and `notify_url`, as well as error messages and files used.'),
-    include_builtin: z
-        .enum(['none', 'latest', 'all', 'exclusively-latest', 'exclusively-all'])
-        .optional()
+    include_builtin: optionalWithV3Semantics(z
+        .enum(['none', 'latest', 'all', 'exclusively-latest', 'exclusively-all']))
         .describe('Include Builtin Templates in the results. Use `latest` (recommended) or `all`. Prefix with `exclusively-` to return only Builtin Templates.'),
 })
     .strict();
@@ -202,15 +193,15 @@ export const templateListParamsSchema = z
 // so that tests can also use them:
 export const assemblyInstructionsWithHiddenSchema = assemblyInstructionsSchema.extend({
     steps: optionalStepsWithHiddenFieldsSchema,
-    imagemagick_stack: z.string().optional(),
-    exiftool_stack: z.string().optional(),
-    mplayer_stack: z.string().optional(),
-    mediainfo_stack: z.string().optional(),
-    ffmpeg_stack: z.string().optional(),
-    usage_tags: z.string().optional(),
-    response_headers: z
+    imagemagick_stack: optionalWithV3Semantics(z.string()),
+    exiftool_stack: optionalWithV3Semantics(z.string()),
+    mplayer_stack: optionalWithV3Semantics(z.string()),
+    mediainfo_stack: optionalWithV3Semantics(z.string()),
+    ffmpeg_stack: optionalWithV3Semantics(z.string()),
+    usage_tags: optionalWithV3Semantics(z.string()),
+    response_headers: optionalWithV3Semantics(z
         .object({
-        cors: z
+        cors: optionalWithV3Semantics(z
             .object({
             'Access-Control-Allow-Methods': z.string(),
             'Access-Control-Allow-Origin': z.string(),
@@ -220,21 +211,18 @@ export const assemblyInstructionsWithHiddenSchema = assemblyInstructionsSchema.e
             'Access-Control-Max-Age': z.number(),
             'Access-Control-Allow-Private-Network': z.boolean(),
             'Access-Control-Allow-Public-Network': z.boolean(),
-        })
-            .optional(),
-    })
-        .optional(),
-    randomize_watermarks: z.boolean().optional(),
-    await: z
+        })),
+    })),
+    randomize_watermarks: optionalWithV3Semantics(z.boolean()),
+    await: optionalWithV3Semantics(z
         .union([
         z.boolean(),
         z.literal('notification'),
         z.literal('persisting'),
         z.literal('transcoding'),
-    ])
-        .optional(),
-    blocking: z.boolean().optional(),
-    reparse_template: z.union([z.literal(1), z.boolean()]).optional(),
-    ignore_upload_meta_data_errors: z.boolean().optional(),
-    emit_execution_progress: z.boolean().optional(),
+    ])),
+    blocking: optionalWithV3Semantics(z.boolean()),
+    reparse_template: optionalWithV3Semantics(z.union([z.literal(1), z.boolean()])),
+    ignore_upload_meta_data_errors: optionalWithV3Semantics(z.boolean()),
+    emit_execution_progress: optionalWithV3Semantics(z.boolean()),
 });

package/dist/v4/templateCredential.d.ts

@@ -23,11 +23,11 @@ export declare const templateCredentialsSchema: z.ZodObject<{
     name: z.ZodString;
     type: z.ZodEnum<{
         http: "http";
-        cloudflare: "cloudflare";
         ai: "ai";
         vimeo: "vimeo";
         azure: "azure";
         backblaze: "backblaze";
+        cloudflare: "cloudflare";
         companion: "companion";
         digitalocean: "digitalocean";
         dropbox: "dropbox";

package/dist/v4/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/v4/utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../src/v4/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/v4/utility.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transloadit/zod",
-  "version": "4.5.0",
+  "version": "5.0.0",
   "description": "Transloadit Zod schemas",
   "type": "module",
   "license": "MIT",
@@ -47,11 +47,10 @@
     "check": "yarn sync && ../../node_modules/.bin/tsc --build tsconfig.build.json && ../../node_modules/.bin/tsc --noEmit --project tsconfig.test.json && yarn test:unit"
   },
   "dependencies": {
-    "type-fest": "^5.6.0",
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@transloadit/types": "^4.5.0",
+    "@transloadit/types": "^5.0.0",
     "@types/node": "^25.8.0"
   }
 }