superdoc-sdk 1.0.0.dev75__tar.gz → 1.1.0__tar.gz

{superdoc_sdk-1.0.0.dev75 → superdoc_sdk-1.1.0}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.4
 Name: superdoc-sdk
-Version: 1.0.0.dev75
+Version: 1.1.0
 Summary: SuperDoc SDK (CLI-backed)
 Author: SuperDoc
 License-Expression: AGPL-3.0
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: superdoc-sdk-cli-darwin-arm64==1.0.0.dev75; platform_system == "Darwin" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
-Requires-Dist: superdoc-sdk-cli-darwin-x64==1.0.0.dev75; platform_system == "Darwin" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
-Requires-Dist: superdoc-sdk-cli-linux-x64==1.0.0.dev75; platform_system == "Linux" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
-Requires-Dist: superdoc-sdk-cli-linux-arm64==1.0.0.dev75; platform_system == "Linux" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
-Requires-Dist: superdoc-sdk-cli-windows-x64==1.0.0.dev75; platform_system == "Windows" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-darwin-arm64==1.1.0; platform_system == "Darwin" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
+Requires-Dist: superdoc-sdk-cli-darwin-x64==1.1.0; platform_system == "Darwin" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-linux-x64==1.1.0; platform_system == "Linux" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-linux-arm64==1.1.0; platform_system == "Linux" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
+Requires-Dist: superdoc-sdk-cli-windows-x64==1.1.0; platform_system == "Windows" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
 
 # superdoc-sdk
 
@@ -167,6 +167,8 @@ Use this when your app already has a live collaboration room (Liveblocks, Hocusp
 
 Pass `collabUrl` and `collabDocumentId` to `client.open`:
 
+> The `collabUrl` + `collabDocumentId` shorthand defaults to the `y-websocket` provider. To connect to a Hocuspocus server, pass an explicit `collaboration` object with `providerType: "hocuspocus"`.
+
 ```python
 import asyncio
 
@@ -189,6 +191,20 @@ async def main():
 asyncio.run(main())
 ```
 
+### Connect to Hocuspocus explicitly
+
+Use the explicit `collaboration` object when your server speaks the Hocuspocus protocol instead of `y-websocket`:
+
+```python
+doc = await client.open({
+    "collaboration": {
+        "providerType": "hocuspocus",
+        "url": "ws://localhost:1234",
+        "documentId": "my-doc-room",
+    }
+})
+```
+
 ### Start an empty room from a local `.docx`
 
 If the room is empty, pass `doc` together with collaboration params:
@@ -213,7 +229,7 @@ What happens when you pass `doc`:
 
 | Parameter | Type | Default | Description |
 | --- | --- | --- | --- |
-| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. |
+| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. Shorthand defaults to `y-websocket`. |
 | `collabDocumentId` | `string` | session ID | Room/document ID on the provider. |
 | `doc` | `string` | — | Local `.docx` used only when the room is empty. |
 | `onMissing` | `string` | `seedFromDoc` | `seedFromDoc`, `blank`, or `error`. |
@@ -400,7 +416,7 @@ pip download superdoc-sdk superdoc-sdk-cli-darwin-arm64
 
 ## Part of SuperDoc
 
-This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — an open source document editor bringing Microsoft Word to the web.
+This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — open-source DOCX editing and tooling. Renders, edits, and automates .docx in the browser and on the server.
 
 ## License
 

{superdoc_sdk-1.0.0.dev75 → superdoc_sdk-1.1.0}/README.md

@@ -153,6 +153,8 @@ Use this when your app already has a live collaboration room (Liveblocks, Hocusp
 
 Pass `collabUrl` and `collabDocumentId` to `client.open`:
 
+> The `collabUrl` + `collabDocumentId` shorthand defaults to the `y-websocket` provider. To connect to a Hocuspocus server, pass an explicit `collaboration` object with `providerType: "hocuspocus"`.
+
 ```python
 import asyncio
 
@@ -175,6 +177,20 @@ async def main():
 asyncio.run(main())
 ```
 
+### Connect to Hocuspocus explicitly
+
+Use the explicit `collaboration` object when your server speaks the Hocuspocus protocol instead of `y-websocket`:
+
+```python
+doc = await client.open({
+    "collaboration": {
+        "providerType": "hocuspocus",
+        "url": "ws://localhost:1234",
+        "documentId": "my-doc-room",
+    }
+})
+```
+
 ### Start an empty room from a local `.docx`
 
 If the room is empty, pass `doc` together with collaboration params:
@@ -199,7 +215,7 @@ What happens when you pass `doc`:
 
 | Parameter | Type | Default | Description |
 | --- | --- | --- | --- |
-| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. |
+| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. Shorthand defaults to `y-websocket`. |
 | `collabDocumentId` | `string` | session ID | Room/document ID on the provider. |
 | `doc` | `string` | — | Local `.docx` used only when the room is empty. |
 | `onMissing` | `string` | `seedFromDoc` | `seedFromDoc`, `blank`, or `error`. |
@@ -386,7 +402,7 @@ pip download superdoc-sdk superdoc-sdk-cli-darwin-arm64
 
 ## Part of SuperDoc
 
-This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — an open source document editor bringing Microsoft Word to the web.
+This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — open-source DOCX editing and tooling. Renders, edits, and automates .docx in the browser and on the server.
 
 ## License
 

superdoc_sdk-1.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=70.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "superdoc-sdk"
+version = "1.1.0"
+description = "SuperDoc SDK (CLI-backed)"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "AGPL-3.0"
+authors = [{ name = "SuperDoc" }]
+dependencies = [
+  "superdoc-sdk-cli-darwin-arm64==1.1.0; platform_system == 'Darwin' and (platform_machine == 'arm64' or platform_machine == 'aarch64' or platform_machine == 'ARM64')",
+  "superdoc-sdk-cli-darwin-x64==1.1.0; platform_system == 'Darwin' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
+  "superdoc-sdk-cli-linux-x64==1.1.0; platform_system == 'Linux' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
+  "superdoc-sdk-cli-linux-arm64==1.1.0; platform_system == 'Linux' and (platform_machine == 'arm64' or platform_machine == 'aarch64' or platform_machine == 'ARM64')",
+  "superdoc-sdk-cli-windows-x64==1.1.0; platform_system == 'Windows' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
+]
+
+[tool.setuptools]
+packages = [
+  "superdoc",
+  "superdoc.generated",
+  "superdoc.skills",
+  "superdoc.tools",
+]
+
+[tool.setuptools.package-data]
+superdoc = [
+  "skills/*.md",
+  "tools/*.json",
+]

{superdoc_sdk-1.0.0.dev75 → superdoc_sdk-1.1.0}/superdoc_sdk.egg-info/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.4
 Name: superdoc-sdk
-Version: 1.0.0.dev75
+Version: 1.1.0
 Summary: SuperDoc SDK (CLI-backed)
 Author: SuperDoc
 License-Expression: AGPL-3.0
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: superdoc-sdk-cli-darwin-arm64==1.0.0.dev75; platform_system == "Darwin" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
-Requires-Dist: superdoc-sdk-cli-darwin-x64==1.0.0.dev75; platform_system == "Darwin" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
-Requires-Dist: superdoc-sdk-cli-linux-x64==1.0.0.dev75; platform_system == "Linux" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
-Requires-Dist: superdoc-sdk-cli-linux-arm64==1.0.0.dev75; platform_system == "Linux" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
-Requires-Dist: superdoc-sdk-cli-windows-x64==1.0.0.dev75; platform_system == "Windows" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-darwin-arm64==1.1.0; platform_system == "Darwin" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
+Requires-Dist: superdoc-sdk-cli-darwin-x64==1.1.0; platform_system == "Darwin" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-linux-x64==1.1.0; platform_system == "Linux" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
+Requires-Dist: superdoc-sdk-cli-linux-arm64==1.1.0; platform_system == "Linux" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")
+Requires-Dist: superdoc-sdk-cli-windows-x64==1.1.0; platform_system == "Windows" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")
 
 # superdoc-sdk
 
@@ -167,6 +167,8 @@ Use this when your app already has a live collaboration room (Liveblocks, Hocusp
 
 Pass `collabUrl` and `collabDocumentId` to `client.open`:
 
+> The `collabUrl` + `collabDocumentId` shorthand defaults to the `y-websocket` provider. To connect to a Hocuspocus server, pass an explicit `collaboration` object with `providerType: "hocuspocus"`.
+
 ```python
 import asyncio
 
@@ -189,6 +191,20 @@ async def main():
 asyncio.run(main())
 ```
 
+### Connect to Hocuspocus explicitly
+
+Use the explicit `collaboration` object when your server speaks the Hocuspocus protocol instead of `y-websocket`:
+
+```python
+doc = await client.open({
+    "collaboration": {
+        "providerType": "hocuspocus",
+        "url": "ws://localhost:1234",
+        "documentId": "my-doc-room",
+    }
+})
+```
+
 ### Start an empty room from a local `.docx`
 
 If the room is empty, pass `doc` together with collaboration params:
@@ -213,7 +229,7 @@ What happens when you pass `doc`:
 
 | Parameter | Type | Default | Description |
 | --- | --- | --- | --- |
-| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. |
+| `collabUrl` | `string` | — | WebSocket URL for your collaboration provider. Shorthand defaults to `y-websocket`. |
 | `collabDocumentId` | `string` | session ID | Room/document ID on the provider. |
 | `doc` | `string` | — | Local `.docx` used only when the room is empty. |
 | `onMissing` | `string` | `seedFromDoc` | `seedFromDoc`, `blank`, or `error`. |
@@ -400,7 +416,7 @@ pip download superdoc-sdk superdoc-sdk-cli-darwin-arm64
 
 ## Part of SuperDoc
 
-This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — an open source document editor bringing Microsoft Word to the web.
+This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — open-source DOCX editing and tooling. Renders, edits, and automates .docx in the browser and on the server.
 
 ## License
 

{superdoc_sdk-1.0.0.dev75 → superdoc_sdk-1.1.0}/superdoc_sdk.egg-info/requires.txt

@@ -1,15 +1,15 @@
 
 [:platform_system == "Darwin" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")]
-superdoc-sdk-cli-darwin-arm64==1.0.0.dev75
+superdoc-sdk-cli-darwin-arm64==1.1.0
 
 [:platform_system == "Darwin" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")]
-superdoc-sdk-cli-darwin-x64==1.0.0.dev75
+superdoc-sdk-cli-darwin-x64==1.1.0
 
 [:platform_system == "Linux" and (platform_machine == "arm64" or platform_machine == "aarch64" or platform_machine == "ARM64")]
-superdoc-sdk-cli-linux-arm64==1.0.0.dev75
+superdoc-sdk-cli-linux-arm64==1.1.0
 
 [:platform_system == "Linux" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")]
-superdoc-sdk-cli-linux-x64==1.0.0.dev75
+superdoc-sdk-cli-linux-x64==1.1.0
 
 [:platform_system == "Windows" and (platform_machine == "x86_64" or platform_machine == "AMD64" or platform_machine == "amd64")]
-superdoc-sdk-cli-windows-x64==1.0.0.dev75
+superdoc-sdk-cli-windows-x64==1.1.0

superdoc_sdk-1.0.0.dev75/pyproject.toml

@@ -1,33 +0,0 @@
-[build-system]
-requires = ["setuptools>=70.1", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "superdoc-sdk"
-version = "1.0.0.dev75"
-description = "SuperDoc SDK (CLI-backed)"
-readme = "README.md"
-requires-python = ">=3.9"
-license = "AGPL-3.0"
-authors = [{ name = "SuperDoc" }]
-dependencies = [
-  "superdoc-sdk-cli-darwin-arm64==1.0.0.dev75; platform_system == 'Darwin' and (platform_machine == 'arm64' or platform_machine == 'aarch64' or platform_machine == 'ARM64')",
-  "superdoc-sdk-cli-darwin-x64==1.0.0.dev75; platform_system == 'Darwin' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
-  "superdoc-sdk-cli-linux-x64==1.0.0.dev75; platform_system == 'Linux' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
-  "superdoc-sdk-cli-linux-arm64==1.0.0.dev75; platform_system == 'Linux' and (platform_machine == 'arm64' or platform_machine == 'aarch64' or platform_machine == 'ARM64')",
-  "superdoc-sdk-cli-windows-x64==1.0.0.dev75; platform_system == 'Windows' and (platform_machine == 'x86_64' or platform_machine == 'AMD64' or platform_machine == 'amd64')",
-]
-
-[tool.setuptools]
-packages = [
-  "superdoc",
-  "superdoc.generated",
-  "superdoc.skills",
-  "superdoc.tools",
-]
-
-[tool.setuptools.package-data]
-superdoc = [
-  "skills/*.md",
-  "tools/*.json",
-]