@leancodepl/api-binary 8.5.0 → 8.6.0

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.default.js

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

package/index.cjs.js

@@ -0,0 +1,36 @@
+'use strict';
+
+/**
+ * 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;
+}
+/**
+ * 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;
+}
+
+exports.fromRaw = fromRaw;
+exports.toRaw = toRaw;

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,33 @@
+/**
+ * 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;
+}
+/**
+ * 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;
+}
+
+export { fromRaw, toRaw };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leancodepl/api-binary",
-  "version": "8.5.0",
+  "version": "8.6.0",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
@@ -32,11 +32,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,36 @@
+export type ApiBinaryRaw = string;
+declare class _ApiBinary {
+    private _;
+}
+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 {};