@leancodepl/api-binary-blob 8.5.0 → 8.6.0

package/README.md

@@ -0,0 +1,86 @@
+# @leancodepl/api-binary-blob
+
+Blob conversion utilities for ApiBinary with file handling support.
+
+## Installation
+
+```bash
+npm install @leancodepl/api-binary-blob
+# or
+yarn add @leancodepl/api-binary-blob
+```
+
+## API
+
+### `fromBlob(blob)`
+
+Converts Blob to ApiBinary asynchronously.
+
+**Parameters:**
+
+- `blob: Blob` - The Blob to convert to ApiBinary
+
+**Returns:** Promise resolving to ApiBinary or undefined if blob is undefined
+
+### `toBlob(apiBinary, contentType)`
+
+Converts ApiBinary to Blob with optional content type.
+
+**Parameters:**
+
+- `apiBinary: ApiBinary` - The ApiBinary to convert to Blob
+- `contentType?: string` - Optional MIME type for the Blob
+
+**Returns:** Blob instance or undefined if apiBinary is null/undefined
+
+## Usage Examples
+
+### File Upload
+
+```typescript
+import { fromBlob, toBlob } from "@leancodepl/api-binary-blob"
+
+const handleFileUpload = async (file: File) => {
+    const binary = await fromBlob(file)
+
+    await api.post("/upload", {
+        fileName: file.name,
+        content: binary,
+    })
+}
+```
+
+### File Download
+
+```typescript
+import { toBlob } from "@leancodepl/api-binary-blob"
+
+const downloadFile = async (binary: ApiBinary, filename: string) => {
+    const blob = toBlob(binary, "application/octet-stream")
+    const url = URL.createObjectURL(blob)
+
+    const link = document.createElement("a")
+    link.href = url
+    link.download = filename
+    link.click()
+
+    URL.revokeObjectURL(url)
+}
+```
+
+### Image Processing
+
+```typescript
+import { fromBlob, toBlob } from "@leancodepl/api-binary-blob"
+
+const processImage = async (imageFile: File) => {
+    const binary = await fromBlob(imageFile)
+
+    const processedBlob = toBlob(binary, "image/jpeg")
+    const preview = URL.createObjectURL(processedBlob)
+
+    const img = document.createElement("img")
+    img.src = preview
+    document.body.appendChild(img)
+}
+```

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var apiBinary = require('@leancodepl/api-binary');
+
+function fromBlob(blob) {
+    if (!blob) return Promise.resolve(undefined);
+    return new Promise((resolve, reject)=>{
+        try {
+            const reader = new FileReader();
+            reader.onloadend = ()=>{
+                const result = reader.result;
+                if (typeof result === "string") {
+                    // we need to strip the `data:*/*;base64,` from the beginning
+                    resolve(apiBinary.fromRaw(result.substring(1 + result.indexOf(",", result.indexOf(";")))));
+                    return;
+                }
+                throw new Error("Unknown blob result received for ApiBinary creation");
+            };
+            reader.onerror = reject;
+            reader.readAsDataURL(blob);
+        } catch (e) {
+            reject(e);
+        }
+    });
+}
+
+function base64toBlob(base64Data, contentType, sliceSize = 512) {
+    const byteCharacters = atob(base64Data);
+    const byteArrays = [];
+    for(let offset = 0; offset < byteCharacters.length; offset += sliceSize){
+        const slice = byteCharacters.slice(offset, offset + sliceSize);
+        const byteNumbers = new Array(slice.length);
+        for(let i = 0; i < slice.length; i++){
+            byteNumbers[i] = slice.charCodeAt(i);
+        }
+        byteArrays.push(new Uint8Array(byteNumbers));
+    }
+    const blob = new Blob(byteArrays, {
+        type: contentType
+    });
+    return blob;
+}
+
+function toBlob(apiBinary$1, contentType) {
+    if (apiBinary$1 === undefined || apiBinary$1 === null) {
+        return undefined;
+    }
+    return base64toBlob(apiBinary.toRaw(apiBinary$1), contentType);
+}
+
+exports.fromBlob = fromBlob;
+exports.toBlob = toBlob;
+Object.keys(apiBinary).forEach(function (k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return apiBinary[k]; }
+    });
+});

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,50 @@
+import { fromRaw, toRaw } from '@leancodepl/api-binary';
+export * from '@leancodepl/api-binary';
+
+function fromBlob(blob) {
+    if (!blob) return Promise.resolve(undefined);
+    return new Promise((resolve, reject)=>{
+        try {
+            const reader = new FileReader();
+            reader.onloadend = ()=>{
+                const result = reader.result;
+                if (typeof result === "string") {
+                    // we need to strip the `data:*/*;base64,` from the beginning
+                    resolve(fromRaw(result.substring(1 + result.indexOf(",", result.indexOf(";")))));
+                    return;
+                }
+                throw new Error("Unknown blob result received for ApiBinary creation");
+            };
+            reader.onerror = reject;
+            reader.readAsDataURL(blob);
+        } catch (e) {
+            reject(e);
+        }
+    });
+}
+
+function base64toBlob(base64Data, contentType, sliceSize = 512) {
+    const byteCharacters = atob(base64Data);
+    const byteArrays = [];
+    for(let offset = 0; offset < byteCharacters.length; offset += sliceSize){
+        const slice = byteCharacters.slice(offset, offset + sliceSize);
+        const byteNumbers = new Array(slice.length);
+        for(let i = 0; i < slice.length; i++){
+            byteNumbers[i] = slice.charCodeAt(i);
+        }
+        byteArrays.push(new Uint8Array(byteNumbers));
+    }
+    const blob = new Blob(byteArrays, {
+        type: contentType
+    });
+    return blob;
+}
+
+function toBlob(apiBinary, contentType) {
+    if (apiBinary === undefined || apiBinary === null) {
+        return undefined;
+    }
+    return base64toBlob(toRaw(apiBinary), contentType);
+}
+
+export { fromBlob, toBlob };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@leancodepl/api-binary-blob",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "license": "Apache-2.0",
   "dependencies": {
-    "@leancodepl/api-binary": "8.5.0"
+    "@leancodepl/api-binary": "8.6.0"
   },
   "devDependencies": {
     "blob-polyfill": "^9.0.0"
@@ -39,11 +39,6 @@
     "name": "LeanCode",
     "url": "https://leancode.co"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md"
-  ],
   "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "@leancodepl/api-binary";
+export * from "./lib/fromBlob";
+export * from "./lib/toBlob";

package/src/lib/base64ToBlob.d.ts

@@ -0,0 +1 @@
+export declare function base64toBlob(base64Data: string, contentType?: string, sliceSize?: number): Blob;

package/src/lib/fromBlob.d.ts

@@ -0,0 +1,17 @@
+import { ApiBinary } from "@leancodepl/api-binary";
+/**
+ * Converts Blob to ApiBinary asynchronously.
+ *
+ * Reads the Blob content as base64 data URL and converts it to ApiBinary format.
+ * Handles both required and optional blob parameters with proper overloads.
+ *
+ * @param blob - The Blob to convert to ApiBinary
+ * @returns Promise resolving to ApiBinary or undefined if blob is undefined
+ * @example
+ * ```typescript
+ * const file = new File(['hello world'], 'test.txt', { type: 'text/plain' });
+ * const binary = await fromBlob(file);
+ * ```
+ */
+export declare function fromBlob(blob: Blob): Promise<ApiBinary>;
+export declare function fromBlob(blob?: Blob): Promise<ApiBinary | undefined>;

package/src/lib/toBlob.d.ts

@@ -0,0 +1,18 @@
+import { ApiBinary } from "@leancodepl/api-binary";
+/**
+ * Converts ApiBinary to Blob with optional content type.
+ *
+ * Transforms ApiBinary base64 data to a Blob object for file operations.
+ * Supports both required and optional parameters.
+ *
+ * @param apiBinary - The ApiBinary to convert to Blob
+ * @param contentType - Optional MIME type for the Blob
+ * @returns Blob instance or undefined if apiBinary is null/undefined
+ * @example
+ * ```typescript
+ * const blob = toBlob(binary, 'image/jpeg');
+ * const url = URL.createObjectURL(blob);
+ * ```
+ */
+export declare function toBlob(apiBinary: ApiBinary, contentType?: string): Blob;
+export declare function toBlob(apiBinary?: ApiBinary | null, contentType?: string): Blob | undefined;