@fjell/client-api 4.4.13 → 4.4.14

package/dist/ops/update.js

@@ -1,20 +0,0 @@
-import LibLogger from '../logger.js';
-
-const logger = LibLogger.get('client-api', 'ops', 'update');
-const getUpdateOperation = (api, apiOptions, utilities)=>{
-    const update = async (ik, item)=>{
-        const requestOptions = Object.assign({}, apiOptions.putOptions, {
-            isAuthenticated: apiOptions.writeAuthenticated
-        });
-        logger.default('update', {
-            ik,
-            item,
-            requestOptions
-        });
-        return utilities.validatePK(await utilities.processOne(api.httpPut(utilities.getPath(ik), item, requestOptions)));
-    };
-    return update;
-};
-
-export { getUpdateOperation };
-//# sourceMappingURL=update.js.map

package/dist/ops/update.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"update.js","sources":["../../src/ops/update.ts"],"sourcesContent":["import {\n  ComKey,\n  Item,\n  PriKey\n} from \"@fjell/core\";\nimport { HttpApi } from \"@fjell/http-api\";\n\nimport { ClientApiOptions } from \"@/ClientApiOptions\";\nimport LibLogger from \"@/logger\";\nimport { Utilities } from \"@/Utilities\";\n\nconst logger = LibLogger.get('client-api', 'ops', 'update');\n\nexport const getUpdateOperation = <\n  V extends Item<S, L1, L2, L3, L4, L5>,\n  S extends string,\n  L1 extends string = never,\n  L2 extends string = never,\n  L3 extends string = never,\n  L4 extends string = never,\n  L5 extends string = never>(\n    api: HttpApi,\n    apiOptions: ClientApiOptions,\n    utilities: Utilities<V, S, L1, L2, L3, L4, L5>\n\n  ) => {\n\n  const update = async (\n    ik: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,\n    item: Partial<Item<S, L1, L2, L3, L4, L5>>,\n  ): Promise<V> => {\n    const requestOptions = Object.assign({}, apiOptions.putOptions, { isAuthenticated: apiOptions.writeAuthenticated });\n    logger.default('update', { ik, item, requestOptions });\n\n    return utilities.validatePK(await utilities.processOne(\n      api.httpPut<V>(\n        utilities.getPath(ik),\n        item,\n        requestOptions,\n      ))) as V;\n  }\n\n  return update;\n}\n"],"names":["logger","LibLogger","get","getUpdateOperation","api","apiOptions","utilities","update","ik","item","requestOptions","Object","assign","putOptions","isAuthenticated","writeAuthenticated","default","validatePK","processOne","httpPut","getPath"],"mappings":";;AAWA,MAAMA,MAAAA,GAASC,SAAAA,CAAUC,GAAG,CAAC,cAAc,KAAA,EAAO,QAAA,CAAA;AAE3C,MAAMC,kBAAAA,GAAqB,CAQ9BC,GAAAA,EACAC,UAAAA,EACAC,SAAAA,GAAAA;IAIF,MAAMC,MAAAA,GAAS,OACbC,EAAAA,EACAC,IAAAA,GAAAA;QAEA,MAAMC,cAAAA,GAAiBC,OAAOC,MAAM,CAAC,EAAC,EAAGP,UAAAA,CAAWQ,UAAU,EAAE;AAAEC,YAAAA,eAAAA,EAAiBT,WAAWU;AAAmB,SAAA,CAAA;QACjHf,MAAAA,CAAOgB,OAAO,CAAC,QAAA,EAAU;AAAER,YAAAA,EAAAA;AAAIC,YAAAA,IAAAA;AAAMC,YAAAA;AAAe,SAAA,CAAA;AAEpD,QAAA,OAAOJ,SAAAA,CAAUW,UAAU,CAAC,MAAMX,UAAUY,UAAU,CACpDd,GAAAA,CAAIe,OAAO,CACTb,SAAAA,CAAUc,OAAO,CAACZ,KAClBC,IAAAA,EACAC,cAAAA,CAAAA,CAAAA,CAAAA;AAEN,IAAA,CAAA;IAEA,OAAOH,MAAAA;AACT;;;;"}

package/docs/docs.config.ts

@@ -1,77 +0,0 @@
-interface DocsConfig {
-  projectName: string;
-  basePath: string;
-  port: number;
-  branding: {
-    theme: string;
-    tagline: string;
-    logo?: string;
-    backgroundImage?: string;
-    primaryColor?: string;
-    accentColor?: string;
-    github?: string;
-    npm?: string;
-  };
-  sections: Array<{
-    id: string;
-    title: string;
-    subtitle: string;
-    file: string;
-  }>;
-  filesToCopy: Array<{
-    source: string;
-    destination: string;
-  }>;
-  plugins?: any[];
-  version: {
-    source: string;
-  };
-  customContent?: {
-    [key: string]: (content: string) => string;
-  };
-}
-
-const config: DocsConfig = {
-  projectName: 'Fjell Client API',
-  basePath: '/client-api/',
-  port: 3002,
-  branding: {
-    theme: 'client-api',
-    tagline: 'HTTP Client Library for Fjell',
-    backgroundImage: '/pano.png',
-    github: 'https://github.com/getfjell/client-api',
-    npm: 'https://www.npmjs.com/package/@fjell/client-api'
-  },
-  sections: [
-    {
-      id: 'overview',
-      title: 'Foundation',
-      subtitle: 'Core concepts & HTTP client capabilities',
-      file: '/client-api/README.md'
-    },
-    {
-      id: 'api-reference',
-      title: 'API Reference',
-      subtitle: 'Complete method documentation',
-      file: '/client-api/api-reference.md'
-    },
-    {
-      id: 'examples',
-      title: 'Examples',
-      subtitle: 'Code examples & usage patterns',
-      file: '/client-api/examples-README.md'
-    }
-  ],
-  filesToCopy: [
-    {
-      source: '../examples/README.md',
-      destination: 'public/examples-README.md'
-    }
-  ],
-  plugins: [],
-  version: {
-    source: 'package.json'
-  }
-}
-
-export default config

package/docs/index.html

@@ -1,18 +0,0 @@
-<!doctype html>
-<html lang="en">
-
-<head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/fjell-icon.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Fjell Client API - TypeScript Client Library</title>
-    <meta name="description"
-        content="Client API for Fjell - A powerful TypeScript client library for service consumption">
-</head>
-
-<body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-</body>
-
-</html>

package/docs/package.json

@@ -1,34 +0,0 @@
-{
-  "name": "fjell-client-api-docs",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "copy-docs": "node node_modules/@fjell/docs-template/scripts/copy-docs.js",
-    "dev": "pnpm run copy-docs && vite",
-    "build": "pnpm run copy-docs && tsc && vite build",
-    "preview": "vite preview",
-    "test": "vitest run --coverage",
-    "test:watch": "vitest --watch"
-  },
-  "dependencies": {
-    "@fjell/docs-template": "1.0.5",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0"
-  },
-  "devDependencies": {
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.3.0",
-    "@testing-library/user-event": "^14.6.1",
-    "@types/react": "^19.1.8",
-    "@types/react-dom": "^19.1.6",
-    "@types/react-syntax-highlighter": "^15.5.13",
-    "@vitejs/plugin-react": "^4.6.0",
-    "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/ui": "^3.2.4",
-    "jsdom": "^26.1.0",
-    "typescript": "^5.8.3",
-    "vite": "^7.0.0",
-    "vitest": "^3.2.4"
-  }
-}

package/docs/public/README.md

@@ -1,165 +0,0 @@
-# Fjell Client API
-
-A comprehensive HTTP client library for the Fjell ecosystem. The Client API provides powerful abstractions for HTTP-based data operations, making it easy to build robust client applications that consume REST APIs.
-
-## Installation
-
-```bash
-npm install @fjell/client-api
-```
-
-## Quick Start
-
-```typescript
-import { createPItemApi, createCItemApi } from '@fjell/client-api'
-
-// Configure API endpoints
-const apiConfig = {
-  baseUrl: 'https://api.example.com',
-  headers: { 'Authorization': 'Bearer token' }
-}
-
-// Create Primary Item API (independent entities)
-const userApi = createPItemApi<User, 'user'>('user', ['users'], apiConfig)
-
-// Create Contained Item API (hierarchical entities)
-const taskApi = createCItemApi<Task, 'task', 'user'>('task', ['users', 'tasks'], apiConfig)
-
-// Basic operations
-const users = await userApi.all(query)
-const user = await userApi.create(userData)
-const tasks = await taskApi.all(query, [userId]) // Location-based query
-```
-
-## Key Features
-
-- **HTTP-based Operations**: Complete CRUD operations over HTTP
-- **Type-safe APIs**: Full TypeScript support with generic type parameters
-- **Hierarchical Data**: Support for nested resource relationships
-- **Business Logic**: Actions and facets for complex operations
-- **Authentication**: Built-in support for various auth patterns
-- **Error Handling**: Comprehensive error handling and retry logic
-
-## Architecture
-
-The Client API is built around two main concepts:
-
-### Primary Items (PItemApi)
-Independent entities that exist at the top level of your API hierarchy. These represent resources that don't require parent context, such as Users, Products, or Organizations.
-
-### Contained Items (CItemApi)
-Entities that belong to parent resources and require location context. These represent hierarchical data like Tasks within Projects, OrderItems within Orders, or Comments within Posts.
-
-This design mirrors RESTful API patterns while providing powerful abstractions for complex business operations.
-
-## Core Concepts
-
-### API Configuration
-Configure your client with base URLs, authentication headers, and other options:
-
-```typescript
-const config = {
-  baseUrl: 'https://api.example.com',
-  headers: {
-    'Content-Type': 'application/json',
-    'Authorization': 'Bearer your-token'
-  },
-  timeout: 5000
-}
-```
-
-### Primary Item API
-For independent resources:
-
-```typescript
-const userApi = createPItemApi<User, 'user'>('user', ['users'], config)
-
-// CRUD operations
-const users = await userApi.all()
-const user = await userApi.get(userKey)
-const newUser = await userApi.create({ name: 'John', email: 'john@example.com' })
-const updatedUser = await userApi.update(userKey, { name: 'John Smith' })
-await userApi.remove(userKey)
-```
-
-### Contained Item API
-For hierarchical resources:
-
-```typescript
-const taskApi = createCItemApi<Task, 'task', 'user'>('task', ['users', 'tasks'], config)
-
-// Operations with location context
-const userTasks = await taskApi.all({}, [userId])
-const task = await taskApi.get(taskKey)
-const newTask = await taskApi.create({ title: 'Complete project' }, [userId])
-```
-
-### Actions and Facets
-Execute business logic and retrieve analytics:
-
-```typescript
-// Actions - execute business operations
-await userApi.action(userKey, 'activate', { reason: 'manual activation' })
-await taskApi.action(taskKey, 'complete', { completedAt: new Date() })
-
-// Facets - retrieve computed data and analytics
-const userStats = await userApi.facet(userKey, 'activity-stats')
-const taskMetrics = await taskApi.allFacet('completion-metrics', { period: 'monthly' })
-```
-
-## Examples
-
-See the `/examples` directory for comprehensive usage patterns:
-
-- **Simple Example**: Basic CRUD operations and client setup
-- **Multi-Level Keys**: Complex hierarchical data with nested relationships
-- **Enterprise Example**: Complete business application with e-commerce workflows
-
-## TypeScript Support
-
-The Client API is built with TypeScript-first design, providing:
-
-- Full type safety for API operations
-- Generic type parameters for custom data models
-- Compile-time validation of API method signatures
-- IntelliSense support for better developer experience
-
-## Error Handling
-
-Built-in error handling with detailed error information:
-
-```typescript
-try {
-  const user = await userApi.get(userKey)
-} catch (error) {
-  console.error('API error:', error.message)
-  // Handle specific error types
-  if (error.status === 404) {
-    // Handle not found
-  } else if (error.status === 401) {
-    // Handle authentication error
-  }
-}
-```
-
-## Advanced Features
-
-### Authentication
-Support for various authentication patterns including Bearer tokens, API keys, and custom headers.
-
-### Request Configuration
-Fine-tune requests with timeout settings, retry logic, and custom middleware.
-
-### Response Processing
-Automatic response parsing and error handling for consistent API interactions.
-
-### Location-based Operations
-Powerful location context system for hierarchical data operations.
-
-## Contributing
-
-This library is part of the Fjell ecosystem. For contributing guidelines and development setup, please refer to the main Fjell documentation.
-
-## License
-
-Licensed under Apache-2.0. See LICENSE file for details.