@leancodepl/api-binary 8.4.0 → 8.5.1

package/README.md

@@ -0,0 +1,45 @@
+# @leancodepl/api-binary
+
+Type-safe binary data handling for API communication.
+
+## Installation
+
+```bash
+npm install @leancodepl/api-binary
+# or
+yarn add @leancodepl/api-binary
+```
+
+## API
+
+### `toRaw(apiBinary)`
+
+Converts ApiBinary to raw string representation.
+
+**Parameters:**
+
+- `apiBinary: ApiBinary` - The ApiBinary value to convert
+
+**Returns:** Raw string representation of the binary data
+
+### `fromRaw(apiBinaryRaw)`
+
+Converts raw string to ApiBinary type.
+
+**Parameters:**
+
+- `apiBinaryRaw: ApiBinaryRaw` - The raw string representation to convert
+
+**Returns:** ApiBinary instance from the raw string
+
+## Usage Examples
+
+### Basic Conversion
+
+```typescript
+import { fromRaw, toRaw } from "@leancodepl/api-binary"
+
+const binary = fromRaw("SGVsbG8gV29ybGQ=")
+const raw = toRaw(binary)
+console.log(raw) // 'SGVsbG8gV29ybGQ='
+```

package/index.cjs.js

@@ -1,9 +1,34 @@
 'use strict';
 
-function toRaw(apiBinary) {
+/**
+ * Converts ApiBinary to raw string representation.
+ * 
+ * Transforms the ApiBinary type to its underlying string representation
+ * for serialization or API communication.
+ * 
+ * @param apiBinary - The ApiBinary value to convert
+ * @returns Raw string representation of the binary data
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * const raw = toRaw(binary);
+ * ```
+ */ function toRaw(apiBinary) {
     return apiBinary;
 }
-function fromRaw(apiBinaryRaw) {
+/**
+ * Converts raw string to ApiBinary type.
+ * 
+ * Transforms a raw string representation to the ApiBinary type
+ * for type-safe handling of binary data in the application.
+ * 
+ * @param apiBinaryRaw - The raw string representation to convert
+ * @returns ApiBinary instance from the raw string
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * ```
+ */ function fromRaw(apiBinaryRaw) {
     return apiBinaryRaw;
 }
 

package/index.esm.js

@@ -1,7 +1,32 @@
-function toRaw(apiBinary) {
+/**
+ * Converts ApiBinary to raw string representation.
+ * 
+ * Transforms the ApiBinary type to its underlying string representation
+ * for serialization or API communication.
+ * 
+ * @param apiBinary - The ApiBinary value to convert
+ * @returns Raw string representation of the binary data
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * const raw = toRaw(binary);
+ * ```
+ */ function toRaw(apiBinary) {
     return apiBinary;
 }
-function fromRaw(apiBinaryRaw) {
+/**
+ * Converts raw string to ApiBinary type.
+ * 
+ * Transforms a raw string representation to the ApiBinary type
+ * for type-safe handling of binary data in the application.
+ * 
+ * @param apiBinaryRaw - The raw string representation to convert
+ * @returns ApiBinary instance from the raw string
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * ```
+ */ function fromRaw(apiBinaryRaw) {
     return apiBinaryRaw;
 }
 

package/package.json

@@ -1,17 +1,48 @@
 {
   "name": "@leancodepl/api-binary",
-  "version": "8.4.0",
+  "version": "8.5.1",
   "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/cqrs-clients/custom-types/binary/api-binary"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Core binary data types for API communication",
+  "keywords": [
+    "binary",
+    "api",
+    "types",
+    "serialization",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
+  },
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/index.d.ts

@@ -4,6 +4,33 @@ declare class _ApiBinary {
 }
 export interface ApiBinary extends _ApiBinary {
 }
+/**
+ * Converts ApiBinary to raw string representation.
+ *
+ * Transforms the ApiBinary type to its underlying string representation
+ * for serialization or API communication.
+ *
+ * @param apiBinary - The ApiBinary value to convert
+ * @returns Raw string representation of the binary data
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * const raw = toRaw(binary);
+ * ```
+ */
 export declare function toRaw(apiBinary: ApiBinary): ApiBinaryRaw;
+/**
+ * Converts raw string to ApiBinary type.
+ *
+ * Transforms a raw string representation to the ApiBinary type
+ * for type-safe handling of binary data in the application.
+ *
+ * @param apiBinaryRaw - The raw string representation to convert
+ * @returns ApiBinary instance from the raw string
+ * @example
+ * ```typescript
+ * const binary = fromRaw('SGVsbG8gV29ybGQ=');
+ * ```
+ */
 export declare function fromRaw(apiBinaryRaw: ApiBinaryRaw): ApiBinary;
 export {};

package/index.esm.d.ts

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