jazz-tools 0.18.2 → 0.18.4

package/src/media/index.native.ts

@@ -1,166 +1,2 @@
-import type ImageResizerType from "@bam.tech/react-native-image-resizer";
-import type { Account, Group } from "jazz-tools";
-import { FileStream } from "jazz-tools";
-import { Image } from "react-native";
-import {
-  CreateImageOptions,
-  SourceType,
-  createImageFactory,
-} from "./create-image.js";
-
-export { highestResAvailable, loadImage, loadImageBySize } from "./utils.js";
-export { createImageFactory };
-
-let ImageResizer: typeof ImageResizerType | undefined;
-
-export async function createImage(
-  imageBlobOrFile: Blob | File | string,
-  options?: CreateImageOptions,
-) {
-  if (!ImageResizer) {
-    try {
-      ImageResizer = (await import("@bam.tech/react-native-image-resizer"))
-        .default;
-    } catch (e) {
-      throw new Error(
-        "ImageResizer is not installed, please run `npm install @bam.tech/react-native-image-resizer`",
-      );
-    }
-  }
-
-  return createImageFactory({
-    getImageSize,
-    getPlaceholderBase64,
-    createFileStreamFromSource,
-    resize,
-  })(imageBlobOrFile, options || {});
-}
-
-async function getImageSize(
-  filePath: SourceType,
-): Promise<{ width: number; height: number }> {
-  if (typeof filePath !== "string") {
-    throw new Error(
-      "createImage(Blob | File) is not supported on this platform",
-    );
-  }
-
-  const { width, height } = await Image.getSize(filePath);
-
-  return { width, height };
-}
-
-async function getPlaceholderBase64(filePath: SourceType): Promise<string> {
-  if (typeof filePath !== "string") {
-    throw new Error(
-      "createImage(Blob | File) is not supported on this platform",
-    );
-  }
-
-  if (!ImageResizer) {
-    throw new Error(
-      "ImageResizer is not installed, please run `npm install @bam.tech/react-native-image-resizer`",
-    );
-  }
-
-  const { uri } = await ImageResizer.createResizedImage(
-    filePath,
-    8,
-    8,
-    "PNG",
-    100,
-  );
-
-  return imageUrlToBase64(uri);
-}
-
-async function resize(
-  filePath: SourceType,
-  width: number,
-  height: number,
-): Promise<string> {
-  if (typeof filePath !== "string") {
-    throw new Error(
-      "createImage(Blob | File) is not supported on this platform",
-    );
-  }
-
-  if (!ImageResizer) {
-    throw new Error(
-      "ImageResizer is not installed, please run `npm install @bam.tech/react-native-image-resizer`",
-    );
-  }
-
-  const mimeType = await getMimeType(filePath);
-
-  const { uri } = await ImageResizer.createResizedImage(
-    filePath,
-    width,
-    height,
-    contentTypeToFormat(mimeType),
-    80,
-  );
-
-  return uri;
-}
-
-function getMimeType(filePath: string): Promise<string> {
-  return fetch(filePath)
-    .then((res) => res.blob())
-    .then((blob) => blob.type);
-}
-
-function contentTypeToFormat(contentType: string) {
-  if (contentType.includes("image/png")) return "PNG";
-  if (contentType.includes("image/jpeg")) return "JPEG";
-  if (contentType.includes("image/webp")) return "WEBP";
-  return "PNG";
-}
-
-export async function createFileStreamFromSource(
-  filePath: SourceType,
-  owner?: Account | Group,
-): Promise<FileStream> {
-  if (typeof filePath !== "string") {
-    throw new Error(
-      "createImage(Blob | File) is not supported on this platform",
-    );
-  }
-
-  const blob = await fetch(filePath).then((res) => res.blob());
-  const arrayBuffer = await toArrayBuffer(blob);
-
-  return FileStream.createFromArrayBuffer(arrayBuffer, blob.type, undefined, {
-    owner,
-  });
-}
-
-// TODO: look for more efficient way to do this as React Native hasn't blob.arrayBuffer()
-function toArrayBuffer(blob: Blob): Promise<ArrayBuffer> {
-  return new Promise((resolve, reject) => {
-    const reader = new FileReader();
-    reader.onloadend = () => {
-      resolve(reader.result as ArrayBuffer);
-    };
-    reader.onerror = (error) => {
-      reject(error);
-    };
-    reader.readAsArrayBuffer(blob);
-  });
-}
-
-async function imageUrlToBase64(url: string): Promise<string> {
-  const response = await fetch(url);
-  const blob = await response.blob();
-  return new Promise((onSuccess, onError) => {
-    try {
-      const reader = new FileReader();
-      reader.onload = function () {
-        onSuccess(reader.result as string);
-      };
-      reader.readAsDataURL(blob);
-    } catch (e) {
-      onError(e);
-    }
-  });
-}
+export * from "./exports";
+export { createImage } from "./create-image/react-native";

package/src/media/index.server.ts

@@ -0,0 +1,2 @@
+export * from "./exports";
+export { createImage } from "./create-image/server";

package/src/media/index.ts

@@ -1,12 +1,7 @@
 import type { ImageDefinition } from "jazz-tools";
-import {
-  CreateImageOptions,
-  SourceType,
-  createImageFactory,
-} from "./create-image.js";
+import { CreateImageOptions } from "./create-image-factory";
 
-export { highestResAvailable, loadImage, loadImageBySize } from "./utils.js";
-export { createImageFactory };
+export * from "./exports";
 
 /**
  * Creates an ImageDefinition from an image file or blob with built-in UX features.
@@ -38,7 +33,20 @@ export { createImageFactory };
  *   }
  * }
  * ```
+ * ```
+ */
+export declare function createImage(
+  imageBlobOrFile: Blob | File,
+  options?: CreateImageOptions,
+): Promise<ImageDefinition>;
+
+/**
+ * Creates an ImageDefinition from an image file path with built-in UX features.
  *
+ * This function creates a specialized CoValue for managing images in Jazz applications.
+ * It supports blurry placeholders, built-in resizing, and progressive loading patterns.
+ *
+ * @returns Promise that resolves to an ImageDefinition
  * @example
  * ```ts
  * // React Native example
@@ -56,6 +64,6 @@ export { createImageFactory };
  * ```
  */
 export declare function createImage(
-  imageBlobOrFile: SourceType,
+  filePath: string,
   options?: CreateImageOptions,
 ): Promise<ImageDefinition>;

package/src/tools/coValues/account.ts

@@ -274,7 +274,9 @@ export class Account extends CoValueBase implements CoValue {
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   toJSON(): object | any[] {
-    return {};
+    return {
+      $jazz: { id: this.$jazz.id },
+    };
   }
 
   [inspect]() {

package/src/tools/coValues/coFeed.ts

@@ -228,6 +228,7 @@ export class CoFeed<out Item = any> extends CoValueBase implements CoValue {
    * @category
    */
   toJSON(): {
+    $jazz: { id: string };
     [key: string]: unknown;
     in: { [key: string]: unknown };
   } {
@@ -240,6 +241,7 @@ export class CoFeed<out Item = any> extends CoValueBase implements CoValue {
           : (v: unknown) => v && (v as CoValue).$jazz.id;
 
     return {
+      $jazz: { id: this.$jazz.id },
       ...Object.fromEntries(
         Object.entries(this).map(([account, entry]) => [
           account,
@@ -257,6 +259,7 @@ export class CoFeed<out Item = any> extends CoValueBase implements CoValue {
 
   /** @internal */
   [inspect](): {
+    $jazz: { id: string };
     [key: string]: unknown;
     in: { [key: string]: unknown };
   } {
@@ -928,6 +931,7 @@ export class FileStream extends CoValueBase implements CoValue {
    * @category Content
    */
   toJSON(): {
+    $jazz: { id: string };
     mimeType?: string;
     totalSizeBytes?: number;
     fileName?: string;
@@ -935,6 +939,7 @@ export class FileStream extends CoValueBase implements CoValue {
     finished?: boolean;
   } {
     return {
+      $jazz: { id: this.$jazz.id },
       ...this.getChunks(),
     };
   }

package/src/tools/coValues/coMap.ts

@@ -185,7 +185,9 @@ export class CoMap extends CoValueBase implements CoValue {
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   toJSON(_key?: string, processedValues?: ID<CoValue>[]): any {
-    const result = {} as Record<string, any>;
+    const result = {
+      $jazz: { id: this.$jazz.id },
+    } as Record<string, any>;
 
     for (const key of this.$jazz.raw.keys()) {
       const tKey = key as CoKeys<this>;

package/src/tools/implementation/zodSchema/schemaTypes/CoMapSchema.ts

@@ -131,6 +131,25 @@ export interface CoMapSchema<
     R
   > | null>;
 
+  /**
+   * @deprecated Use `co.map().catchall` will be removed in an upcoming version.
+   *
+   * Use a `co.record` nested inside a `co.map` if you need to store key-value properties.
+   *
+   * @example
+   * ```ts
+   * // Instead of:
+   * const Image = co.map({
+   *   original: co.fileStream(),
+   * }).catchall(co.fileStream());
+   *
+   * // Use:
+   * const Image = co.map({
+   *   original: co.fileStream(),
+   *   resolutions: co.record(z.string(), co.fileStream()),
+   * });
+   * ```
+   */
   catchall<T extends AnyZodOrCoValueSchema>(schema: T): CoMapSchema<Shape, T>;
 
   withMigration(