@pluv/platform-cloudflare 0.0.0 → 0.1.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-cloudflare@0.0.0 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.1.0 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -9,9 +9,9 @@
 ESM Build start
 CJS Build start
 ESM dist/index.mjs 1.50 KB
-ESM ⚡️ Build success in 80ms
+ESM ⚡️ Build success in 123ms
 CJS dist/index.js 2.52 KB
-CJS ⚡️ Build success in 82ms
+CJS ⚡️ Build success in 125ms
 DTS Build start
-DTS ⚡️ Build success in 3633ms
+DTS ⚡️ Build success in 4328ms
 DTS dist/index.d.ts 1.03 KB

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @pluv/platform-cloudflare
+
+## 0.1.0
+
+### Minor Changes
+
+- a22f525: Added documentation
+
+### Patch Changes
+
+- Updated dependencies [a22f525]
+  - @pluv/io@0.1.0
+  - @pluv/types@0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shoubhit Dash
+
+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,65 @@
+<h1 align="center">
+  <br>
+  <img src="https://github.com/pluv-io/pluv/blob/master/assets/pluv-icon-192x192.png?raw=true" alt="Pluv.IO" width="180" style="border-radius:16px">
+  <br>
+  Pluv.IO (preview)
+  <br>
+</h1>
+
+<h3 align="center">Multi-platform, E2E type-safe realtime packages</h3>
+<h4 align="center">💕 Inspired by <a href="https://trpc.io">trpc</a> 💕 Built with <a href="https://docs.yjs.dev/">yjs</a> 💕</h4>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@pluv/platform-cloudflare">
+    <img src="https://img.shields.io/npm/v/@pluv/platform-cloudflare" alt="npm @pluv/platform-cloudflare" />
+  </a>
+  <a href="https://github.com/pluv-io/pluv/blob/master/LICENSE">
+    <img alt="GitHub" src="https://img.shields.io/github/license/pluv-io/pluv" alt="License MIT" />
+  </a>
+  <img src="https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555" alt="TypeScript">
+  <a href="https://commitizen.github.io/cz-cli/">
+    <img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" />
+  </a>
+  <img src="https://img.shields.io/badge/docs-coming%20soon!-blue" alt="Docs coming soon!" />
+</p>
+
+<img src="https://github.com/pluv-io/pluv/blob/master/assets/demo-events.gif?raw=true" alt="Demo" />
+
+## `@pluv/platform-cloudflare`
+
+> Enables [@pluv/io](https://img.shields.io/npm/v/@pluv/io) to run on [Cloudflare Workers](https://workers.cloudflare.com/).
+
+## Installation
+
+```bash
+# npm
+npm install @pluv/platform-cloudflare
+
+# yarn
+yarn add @pluv/platform-cloudflare
+
+# pnpm
+pnpm add @pluv/platform-cloudflare
+```
+
+## Basic Example
+
+```ts
+import { createIO } from "@pluv/io";
+import { platformCloudflare } from "@pluv/platform-cloudflare";
+
+export const io = createIO({
+    platform: platformCloudflare(),
+});
+
+/* Somewhere in a Cloudflare worker durable object */
+const { 0: client, 1: server } = new WebSocketPair();
+
+await io.register(server);
+
+return new Response(null, { status: 101, webSocket: client });
+```
+
+## Reference
+
+Check us out on [GitHub](https://github.com/pluv-io/pluv) for more information on how to use `@pluv/io`.

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@pluv/platform-cloudflare",
-  "version": "0.0.0",
+  "version": "0.1.0",
+  "description": "@pluv/io adapter for cloudflare workers",
+  "author": "leedavidcs",
+  "license": "MIT",
+  "homepage": "https://github.com/pluv-io/pluv",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pluv-io/pluv.git",
+    "directory": "packages/platform-cloudflare"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -8,13 +17,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@pluv/io": "^0.0.0",
-    "@pluv/types": "^0.0.0"
+    "@pluv/io": "^0.1.0",
+    "@pluv/types": "^0.1.0"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^3.18.0",
-    "@pluv/tsconfig": "^0.0.0",
-    "eslint-config-pluv": "^0.0.0",
+    "@pluv/tsconfig": "^0.1.0",
+    "eslint-config-pluv": "^0.1.0",
     "tsup": "^6.5.0",
     "typescript": "^4.9.4"
   },