@editframe/api 0.15.0-beta.3 → 0.15.0-beta.7

package/dist/resources/image-file.d.ts

@@ -4,15 +4,15 @@ export declare const CreateImageFilePayload: z.ZodObject<{
     /**
      * The md5 hash of the image file.
      */
-    md5: z.ZodString;
+    md5: z.ZodNullable<z.ZodString>;
     /**
      * The height of the image file in pixels.
      */
-    height: z.ZodNumber;
+    height: z.ZodNullable<z.ZodNumber>;
     /**
      * The width of the image file in pixels.
      */
-    width: z.ZodNumber;
+    width: z.ZodNullable<z.ZodNumber>;
     /**
      * The mime type of the image file.
      */
@@ -26,25 +26,37 @@ export declare const CreateImageFilePayload: z.ZodObject<{
      */
     byte_size: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    width: number;
-    height: number;
+    width: number | null;
+    height: number | null;
     filename: string;
-    md5: string;
+    md5: string | null;
     mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
 }, {
-    width: number;
-    height: number;
+    width: number | null;
+    height: number | null;
     filename: string;
-    md5: string;
+    md5: string | null;
     mime_type: "image/jpeg" | "image/png" | "image/jpg" | "image/webp";
     byte_size: number;
 }>;
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 export interface CreateImageFileResult {
+    /**
+     * Whether the image file has been fully uploaded.
+     */
     complete: boolean | null;
+    /**
+     * The byte size of the image file.
+     */
     byte_size: number;
+    /**
+     * The id of the image file.
+     */
     id: string;
+    /**
+     * The md5 hash of the image file.
+     */
     md5: string;
 }
 export interface LookupImageFileByMd5Result {

package/dist/resources/image-file.js

@@ -7,15 +7,15 @@ const CreateImageFilePayload = z.object({
   /**
    * The md5 hash of the image file.
    */
-  md5: z.string(),
+  md5: z.string().nullable(),
   /**
    * The height of the image file in pixels.
    */
-  height: z.number().int(),
+  height: z.number().int().nullable(),
   /**
    * The width of the image file in pixels.
    */
-  width: z.number().int(),
+  width: z.number().int().nullable(),
   /**
    * The mime type of the image file.
    */

package/dist/resources/renders.d.ts

@@ -7,6 +7,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     width: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
     work_slice_ms: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    html: z.ZodOptional<z.ZodString>;
     duration_ms: z.ZodOptional<z.ZodNumber>;
     strategy: z.ZodOptional<z.ZodDefault<z.ZodEnum<["v1"]>>>;
 }, "strip", z.ZodTypeAny, {
@@ -17,6 +18,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     duration_ms?: number | undefined;
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
+    html?: string | undefined;
 }, {
     width?: number | undefined;
     height?: number | undefined;
@@ -25,6 +27,7 @@ export declare const CreateRenderPayload: z.ZodObject<{
     duration_ms?: number | undefined;
     fps?: number | undefined;
     work_slice_ms?: number | undefined;
+    html?: string | undefined;
 }>;
 export interface CreateRenderPayload {
     md5?: string;
@@ -32,6 +35,7 @@ export interface CreateRenderPayload {
     width?: number;
     height?: number;
     work_slice_ms?: number;
+    html?: string;
     duration_ms?: number;
     strategy?: "v1";
 }

package/dist/resources/renders.js

@@ -8,13 +8,14 @@ const CreateRenderPayload = z.object({
   width: z.number().int().min(2).optional(),
   height: z.number().int().min(2).optional(),
   work_slice_ms: z.number().int().min(1e3).max(1e4).default(4e3).optional(),
+  html: z.string().optional(),
   duration_ms: z.number().int().optional(),
   strategy: z.enum(["v1"]).default("v1").optional()
 });
 const createRender = async (client, payload) => {
   log("Creating render", payload);
   payload.strategy ??= "v1";
-  payload.work_slice_ms ??= 2e3;
+  payload.work_slice_ms ??= 4e3;
   const response = await client.authenticatedFetch("/api/v1/renders", {
     method: "POST",
     body: JSON.stringify(payload)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@editframe/api",
-  "version": "0.15.0-beta.3",
+  "version": "0.15.0-beta.7",
   "description": "API functions for EditFrame",
   "exports": {
     ".": {
@@ -20,14 +20,15 @@
         "types": "./dist/resources/renders.bundle.d.ts",
         "default": "./dist/resources/renders.bundle.js"
       }
-    }
+    },
+    "./types.json": "./dist/types.json"
   },
   "type": "module",
   "scripts": {
     "typecheck": "tsc --noEmit --emitDeclarationOnly false",
     "build": "vite build",
     "build:watch": "vite build --watch",
-    "typedoc": "typedoc --json ../../docs/api.json --plugin typedoc-plugin-zod --excludeExternals ./src"
+    "typedoc": "typedoc --json ./types.json --plugin typedoc-plugin-zod --excludeExternals ./src && jq -c . ./types.json > ./types.tmp.json && mv ./types.tmp.json ./types.json"
   },
   "author": "",
   "license": "UNLICENSED",
@@ -39,7 +40,7 @@
     "vite-plugin-dts": "^4.0.3"
   },
   "dependencies": {
-    "@editframe/assets": "0.15.0-beta.3",
+    "@editframe/assets": "0.15.0-beta.7",
     "@vitejs/plugin-react": "^4.3.4",
     "vite-tsconfig-paths": "^4.3.2",
     "vite": "^5.4.11",

package/src/resources/image-file.ts

@@ -12,15 +12,15 @@ export const CreateImageFilePayload = z.object({
   /**
    * The md5 hash of the image file.
    */
-  md5: z.string(),
+  md5: z.string().nullable(),
   /**
    * The height of the image file in pixels.
    */
-  height: z.number().int(),
+  height: z.number().int().nullable(),
   /**
    * The width of the image file in pixels.
    */
-  width: z.number().int(),
+  width: z.number().int().nullable(),
   /**
    * The mime type of the image file.
    */
@@ -38,9 +38,21 @@ export const CreateImageFilePayload = z.object({
 export type CreateImageFilePayload = z.infer<typeof CreateImageFilePayload>;
 
 export interface CreateImageFileResult {
+  /**
+   * Whether the image file has been fully uploaded.
+   */
   complete: boolean | null;
+  /**
+   * The byte size of the image file.
+   */
   byte_size: number;
+  /**
+   * The id of the image file.
+   */
   id: string;
+  /**
+   * The md5 hash of the image file.
+   */
   md5: string;
 }
 

package/src/resources/renders.ts

@@ -19,6 +19,7 @@ export const CreateRenderPayload = z.object({
     .max(10_000)
     .default(4_000)
     .optional(),
+  html: z.string().optional(),
   duration_ms: z.number().int().optional(),
   strategy: z.enum(["v1"]).default("v1").optional(),
 });
@@ -29,6 +30,7 @@ export interface CreateRenderPayload {
   width?: number;
   height?: number;
   work_slice_ms?: number;
+  html?: string;
   duration_ms?: number;
   strategy?: "v1";
 }
@@ -58,7 +60,7 @@ export const createRender = async (
   // And if we set the default last, the type is not inferred correctly
   // Manually applying defaults here is a hack
   payload.strategy ??= "v1";
-  payload.work_slice_ms ??= 2_000;
+  payload.work_slice_ms ??= 4_000;
   const response = await client.authenticatedFetch("/api/v1/renders", {
     method: "POST",
     body: JSON.stringify(payload),