@relyio/sdk 0.2.0

package/dist/utils/index.cjs

@@ -0,0 +1,81 @@
+'use strict';
+
+var chunkHT6NFRM2_cjs = require('../chunk-HT6NFRM2.cjs');
+require('../chunk-MWMSFIWN.cjs');
+
+
+
+Object.defineProperty(exports, "camelToSnake", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.camelToSnake; }
+});
+Object.defineProperty(exports, "createDeferred", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.createDeferred; }
+});
+Object.defineProperty(exports, "debounce", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.debounce; }
+});
+Object.defineProperty(exports, "deepClone", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.deepClone; }
+});
+Object.defineProperty(exports, "generateId", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.generateId; }
+});
+Object.defineProperty(exports, "isBrowser", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.isBrowser; }
+});
+Object.defineProperty(exports, "isNode", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.isNode; }
+});
+Object.defineProperty(exports, "isPlainObject", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.isPlainObject; }
+});
+Object.defineProperty(exports, "isValidEmail", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.isValidEmail; }
+});
+Object.defineProperty(exports, "isValidUrl", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.isValidUrl; }
+});
+Object.defineProperty(exports, "mergeDeep", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.mergeDeep; }
+});
+Object.defineProperty(exports, "omit", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.omit; }
+});
+Object.defineProperty(exports, "pick", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.pick; }
+});
+Object.defineProperty(exports, "retry", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.retry; }
+});
+Object.defineProperty(exports, "sleep", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.sleep; }
+});
+Object.defineProperty(exports, "snakeToCamel", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.snakeToCamel; }
+});
+Object.defineProperty(exports, "throttle", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.throttle; }
+});
+Object.defineProperty(exports, "toSafeString", {
+  enumerable: true,
+  get: function () { return chunkHT6NFRM2_cjs.toSafeString; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/utils/index.d.cts

@@ -0,0 +1,87 @@
+/**
+ * Utility functions for the RelyIO SDK
+ */
+/**
+ * Check if code is running in a browser environment
+ */
+declare function isBrowser(): boolean;
+/**
+ * Check if code is running in a Node.js environment
+ */
+declare function isNode(): boolean;
+/**
+ * Deep clone an object
+ */
+declare function deepClone<T>(obj: T): T;
+/**
+ * Debounce function calls
+ */
+declare function debounce<T extends (..._args: unknown[]) => unknown>(func: T, wait: number): (...args: Parameters<T>) => void;
+/**
+ * Throttle function calls
+ */
+declare function throttle<T extends (..._args: unknown[]) => unknown>(func: T, limit: number): (...args: Parameters<T>) => void;
+/**
+ * Create a promise that can be resolved/rejected externally
+ */
+declare function createDeferred<T = unknown>(): {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: unknown) => void;
+};
+/**
+ * Wait for a specified amount of time
+ */
+declare function sleep(ms: number): Promise<void>;
+/**
+ * Retry a function with exponential backoff
+ */
+declare function retry<T>(fn: () => Promise<T>, options?: {
+    maxAttempts?: number;
+    baseDelay?: number;
+    maxDelay?: number;
+    backoffFactor?: number;
+    jitter?: boolean;
+}): Promise<T>;
+/**
+ * Convert a value to a safe string for logging
+ */
+declare function toSafeString(value: unknown): string;
+/**
+ * Generate a unique ID
+ */
+declare function generateId(): string;
+/**
+ * Check if a value is a plain object
+ */
+declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+/**
+ * Merge objects deeply
+ */
+declare function mergeDeep<T extends Record<string, unknown>>(target: T, ...sources: Partial<T>[]): T;
+/**
+ * Pick specific keys from an object
+ */
+declare function pick<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+/**
+ * Omit specific keys from an object
+ */
+declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+/**
+ * Convert camelCase to snake_case
+ */
+declare function camelToSnake(str: string): string;
+/**
+ * Convert snake_case to camelCase
+ */
+declare function snakeToCamel(str: string): string;
+/**
+ * Validate email format
+ */
+declare function isValidEmail(email: string): boolean;
+/**
+ * Validate URL format
+ */
+declare function isValidUrl(url: string): boolean;
+
+export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString };

package/dist/utils/index.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Utility functions for the RelyIO SDK
+ */
+/**
+ * Check if code is running in a browser environment
+ */
+declare function isBrowser(): boolean;
+/**
+ * Check if code is running in a Node.js environment
+ */
+declare function isNode(): boolean;
+/**
+ * Deep clone an object
+ */
+declare function deepClone<T>(obj: T): T;
+/**
+ * Debounce function calls
+ */
+declare function debounce<T extends (..._args: unknown[]) => unknown>(func: T, wait: number): (...args: Parameters<T>) => void;
+/**
+ * Throttle function calls
+ */
+declare function throttle<T extends (..._args: unknown[]) => unknown>(func: T, limit: number): (...args: Parameters<T>) => void;
+/**
+ * Create a promise that can be resolved/rejected externally
+ */
+declare function createDeferred<T = unknown>(): {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    reject: (reason?: unknown) => void;
+};
+/**
+ * Wait for a specified amount of time
+ */
+declare function sleep(ms: number): Promise<void>;
+/**
+ * Retry a function with exponential backoff
+ */
+declare function retry<T>(fn: () => Promise<T>, options?: {
+    maxAttempts?: number;
+    baseDelay?: number;
+    maxDelay?: number;
+    backoffFactor?: number;
+    jitter?: boolean;
+}): Promise<T>;
+/**
+ * Convert a value to a safe string for logging
+ */
+declare function toSafeString(value: unknown): string;
+/**
+ * Generate a unique ID
+ */
+declare function generateId(): string;
+/**
+ * Check if a value is a plain object
+ */
+declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+/**
+ * Merge objects deeply
+ */
+declare function mergeDeep<T extends Record<string, unknown>>(target: T, ...sources: Partial<T>[]): T;
+/**
+ * Pick specific keys from an object
+ */
+declare function pick<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+/**
+ * Omit specific keys from an object
+ */
+declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+/**
+ * Convert camelCase to snake_case
+ */
+declare function camelToSnake(str: string): string;
+/**
+ * Convert snake_case to camelCase
+ */
+declare function snakeToCamel(str: string): string;
+/**
+ * Validate email format
+ */
+declare function isValidEmail(email: string): boolean;
+/**
+ * Validate URL format
+ */
+declare function isValidUrl(url: string): boolean;
+
+export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString };

package/dist/utils/index.js

@@ -0,0 +1,4 @@
+export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString } from '../chunk-I3ESNANB.js';
+import '../chunk-XQ4QHWZE.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,159 @@
+{
+  "name": "@relyio/sdk",
+  "version": "0.2.0",
+  "description": "The official TypeScript SDK for RelyIO - a type-safe, performant, and developer-friendly client library",
+  "keywords": [
+    "relyio",
+    "cms",
+    "headless",
+    "typescript",
+    "sdk",
+    "content-management",
+    "api-client",
+    "real-time",
+    "offline-first"
+  ],
+  "author": "RelyIO Team <team@relyio.com>",
+  "license": "Apache-2.0",
+  "homepage": "https://relyio.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/relyio/relyio.git",
+    "directory": "packages/customer/sdk"
+  },
+  "bugs": {
+    "email": "team@relyio.com"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./schema": {
+      "types": "./dist/schema/index.d.ts",
+      "import": "./dist/schema/index.js",
+      "require": "./dist/schema/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/types/index.js",
+      "require": "./dist/types/index.cjs"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js",
+      "require": "./dist/client/index.cjs"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "mitt": "^3.0.1"
+  },
+  "devDependencies": {
+    "@changesets/cli": "2.29.4",
+    "@eslint/js": "9.39.5",
+    "@types/node": "24.13.3",
+    "@types/react": "19.2.18",
+    "@typescript-eslint/eslint-plugin": "^8.18.1",
+    "@typescript-eslint/parser": "^8.18.1",
+    "@vitest/coverage-v8": "4.1.11",
+    "@vitest/ui": "4.1.11",
+    "bundlesize2": "^0.0.31",
+    "eslint": "9.39.5",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-import": "2.32.0",
+    "openapi-typescript": "7.13.0",
+    "prettier": "3.5.3",
+    "rimraf": "6.1.3",
+    "tsup": "8.5.1",
+    "typedoc": "^0.27.5",
+    "typescript": "5.9.3",
+    "vitest": "4.1.11",
+    "@relyio/eslint-config": "0.0.0",
+    "@relyio/api-contract": "0.1.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.9.0",
+    "react": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "bundlesize": [
+    {
+      "path": "./dist/index.js",
+      "maxSize": "15kb",
+      "compression": "gzip"
+    },
+    {
+      "path": "./dist/client.js",
+      "maxSize": "10kb",
+      "compression": "gzip"
+    },
+    {
+      "path": "./dist/types.js",
+      "maxSize": "5kb",
+      "compression": "gzip"
+    },
+    {
+      "path": "./dist/utils.js",
+      "maxSize": "8kb",
+      "compression": "gzip"
+    }
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "build:analyze": "tsup --metafile",
+    "dev": "tsup --watch --onSuccess \"echo 'SDK build complete'\"",
+    "clean": "rimraf dist",
+    "test": "vitest run",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage",
+    "test:ui": "vitest --ui",
+    "type:check": "tsc --noEmit",
+    "codegen:openapi": "node ../../../scripts/emit-openapi-types.mjs ../../../apps/services/api/openapi-spec.json src/http/api-schema.ts",
+    "lint:write": "eslint . --fix",
+    "lint:check": "eslint .",
+    "format:write": "prettier --write \"src/**/*.{ts,tsx,json,md}\"",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch",
+    "benchmark": "vitest bench",
+    "size": "bundlesize",
+    "release": "changeset publish",
+    "version": "changeset version"
+  }
+}