@dxos/functions-runtime-cloudflare 0.8.4-main.3c1ae3b

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# @dxos/functions-runtime-cloudflare
+
+Functions Runtime for Cloudflare Workers.
+
+## Overview
+
+This package provides a runtime adapter for executing DXOS functions on Cloudflare Workers. It wraps user-defined function code and provides a standardized execution context with access to DXOS services.
+
+### Key Responsibilities
+
+- **Function Wrapping**: The `wrapHandlerForCloudflare` function wraps user code into a Cloudflare-compatible fetch handler, managing request parsing, error handling, and response formatting.
+- **Service Bridging**: Provides protobuf-based service implementations (`DataService`, `QueryService`, `QueueService`) that bridge the edge environment services to the function context.
+- **Context Creation**: Constructs a `FunctionProtocol.Context` with access to space metadata, document operations, and queue management.
+
+### Architecture
+
+```
+User Function Code
+       ↓
+wrapHandlerForCloudflare()
+       ↓
+ServiceContainer (bridges edge bindings → protobuf services)
+       ↓
+FunctionProtocol.Context { dataService, queryService, queueService }
+       ↓
+Cloudflare Worker Ready Function Handler
+```
+
+The edge environment provides low-level service bindings (`EdgeFunctionEnv.DataService`, `EdgeFunctionEnv.QueueService`). This package adapts those bindings into protobuf-defined service interfaces that user functions can consume uniformly.
+
+## Installation
+
+```bash
+pnpm i @dxos/functions-runtime-cloudflare
+```
+
+## DXOS Resources
+
+- [Website](https://dxos.org)
+- [Developer Documentation](https://docs.dxos.org)
+- Talk to us on [Discord](https://dxos.org/discord)
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2022 © DXOS