One storage API for Google Drive, Nextcloud, and S3-compatible clouds, in TypeScript and Python.
TypeScript byoccloud-storagecloudflare-r2encryptiongoogle-drivenextcloudoauth2pkcepythons3sdkstoragetypescriptwebdav
fix(ci): make the branch installable, skippable, and scannable
Ajay Raminenieed094387d8d
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlindex ca5686c..46701ec 100644--- a/.github/workflows/ci.yml+++ b/.github/workflows/ci.yml@@ -77,7 +77,10 @@ jobs:- name: Dependency vulnerability auditif: matrix.python-version == '3.13'- run: pip-audit+ # --skip-editable: the project itself is installed with `pip install -e`,+ # and pip-audit fails outright when it cannot find that version on PyPI.+ # An unreleased version is the normal state on a feature branch.+ run: pip-audit --skip-editableintegration:name: Live integration (MinIO + WebDAV)diff --git a/examples/node-quickstart/package.json b/examples/node-quickstart/package.jsonindex 954c685..bd3fd9c 100644--- a/examples/node-quickstart/package.json+++ b/examples/node-quickstart/package.json@@ -1,6 +1,6 @@{"name": "example-node-quickstart",- "version": "0.3.0",+ "version": "0.4.0","private": true,"description": "Quickstart example consuming @byoc/core and @byoc/google-drive","main": "index.ts",@@ -9,11 +9,11 @@"build": "tsc -b"},"dependencies": {- "@byoc/core": "0.3.0",- "@byoc/google-drive": "0.3.0",- "@byoc/local": "0.3.0",- "@byoc/memory": "0.3.0",- "@byoc/s3-compatible": "0.3.0",- "@byoc/webdav": "0.3.0"+ "@byoc/core": "^0.4.0",+ "@byoc/google-drive": "^0.4.0",+ "@byoc/local": "^0.4.0",+ "@byoc/memory": "^0.4.0",+ "@byoc/s3-compatible": "^0.4.0",+ "@byoc/webdav": "^0.4.0"}}diff --git a/package-lock.json b/package-lock.jsonindex a584523..c4f7618 100644--- a/package-lock.json+++ b/package-lock.json@@ -1,12 +1,12 @@{"name": "byoc-monorepo",- "version": "0.3.0",+ "version": "0.4.0","lockfileVersion": 3,"requires": true,"packages": {"": {"name": "byoc-monorepo",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","workspaces": ["packages/*",@@ -23,16 +23,20 @@},"examples/node-quickstart": {"name": "example-node-quickstart",- "version": "0.3.0",+ "version": "0.4.0","dependencies": {- "@byoc/core": "0.3.0",- "@byoc/google-drive": "0.3.0",- "@byoc/local": "0.3.0",- "@byoc/memory": "0.3.0",- "@byoc/s3-compatible": "0.3.0",- "@byoc/webdav": "0.3.0"+ "@byoc/core": "^0.4.0",+ "@byoc/google-drive": "^0.4.0",+ "@byoc/local": "^0.4.0",+ "@byoc/memory": "^0.4.0",+ "@byoc/s3-compatible": "^0.4.0",+ "@byoc/webdav": "^0.4.0"}},+ "node_modules/@byoc/browser": {+ "resolved": "packages/browser",+ "link": true+ },"node_modules/@byoc/core": {"resolved": "packages/core","link": true@@ -1724,9 +1728,17 @@"node": ">=8"}},+ "packages/browser": {+ "name": "@byoc/browser",+ "version": "0.4.0",+ "license": "Apache-2.0",+ "dependencies": {+ "@byoc/core": "^0.4.0"+ }+ },"packages/core": {"name": "@byoc/core",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {"@types/node": ">=20"@@ -1737,10 +1749,10 @@},"packages/google-drive": {"name": "@byoc/google-drive",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0",+ "@byoc/core": "^0.4.0","@types/node": ">=20"},"engines": {@@ -1749,10 +1761,10 @@},"packages/local": {"name": "@byoc/local",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0",+ "@byoc/core": "^0.4.0","@types/node": ">=20"},"engines": {@@ -1761,10 +1773,10 @@},"packages/memory": {"name": "@byoc/memory",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"engines": {"node": ">=20"@@ -1772,10 +1784,10 @@},"packages/provider-sdk": {"name": "@byoc/provider-sdk",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"engines": {"node": ">=20"@@ -1783,10 +1795,10 @@},"packages/s3-compatible": {"name": "@byoc/s3-compatible",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"engines": {"node": ">=20"@@ -1794,10 +1806,10 @@},"packages/webdav": {"name": "@byoc/webdav",- "version": "0.3.0",+ "version": "0.4.0","license": "Apache-2.0","dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"engines": {"node": ">=20"diff --git a/package.json b/package.jsonindex 989989c..29bddf2 100644--- a/package.json+++ b/package.json@@ -1,6 +1,6 @@{"name": "byoc-monorepo",- "version": "0.3.0",+ "version": "0.4.0","private": true,"description": "BYOC (Bring Your Own Cloud) \u2014 Universal Storage Abstraction Layer","license": "Apache-2.0",diff --git a/packages/core/package.json b/packages/core/package.jsonindex 307e768..b720952 100644--- a/packages/core/package.json+++ b/packages/core/package.json@@ -1,6 +1,6 @@{"name": "@byoc/core",- "version": "0.3.0",+ "version": "0.4.0","description": "Core universal storage abstraction for BYOC (Bring Your Own Cloud)","type": "module","main": "./dist/index.js",diff --git a/packages/google-drive/package.json b/packages/google-drive/package.jsonindex 4803169..96e2fe4 100644--- a/packages/google-drive/package.json+++ b/packages/google-drive/package.json@@ -1,6 +1,6 @@{"name": "@byoc/google-drive",- "version": "0.3.0",+ "version": "0.4.0","description": "Google Drive storage provider adapter for BYOC (Bring Your Own Cloud)","type": "module","main": "./dist/index.js",@@ -23,7 +23,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0",+ "@byoc/core": "^0.4.0","@types/node": ">=20"},"keywords": [diff --git a/packages/google-drive/src/adapter.ts b/packages/google-drive/src/adapter.tsindex a89f7cc..477eb66 100644--- a/packages/google-drive/src/adapter.ts+++ b/packages/google-drive/src/adapter.ts@@ -74,7 +74,7 @@ export class GoogleDriveProvider implements BYOCProvider {category: "personal-cloud",authentication: "oauth2",supportsUserOwnedStorage: true,- adapterVersion: "0.3.0"+ adapterVersion: "0.4.0"};}diff --git a/packages/local/package.json b/packages/local/package.jsonindex 2b313f2..f2cb2bc 100644--- a/packages/local/package.json+++ b/packages/local/package.json@@ -1,6 +1,6 @@{"name": "@byoc/local",- "version": "0.3.0",+ "version": "0.4.0","description": "Local filesystem storage adapter for BYOC. No account, no network, no credentials.","type": "module","main": "./dist/index.js",@@ -23,7 +23,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0",+ "@byoc/core": "^0.4.0","@types/node": ">=20"},"keywords": [diff --git a/packages/local/src/adapter.ts b/packages/local/src/adapter.tsindex f6a3e3e..4c31420 100644--- a/packages/local/src/adapter.ts+++ b/packages/local/src/adapter.ts@@ -67,7 +67,7 @@ export class LocalFileSystemProvider implements BYOCProvider {category: "self-hosted",authentication: "local",supportsUserOwnedStorage: true,- adapterVersion: "0.3.0"+ adapterVersion: "0.4.0"};}diff --git a/packages/memory/package.json b/packages/memory/package.jsonindex e387dcf..8a27e9b 100644--- a/packages/memory/package.json+++ b/packages/memory/package.json@@ -1,6 +1,6 @@{"name": "@byoc/memory",- "version": "0.3.0",+ "version": "0.4.0","description": "In-memory BYOC storage adapter: a test double that behaves like a real provider.","type": "module","main": "./dist/index.js",@@ -23,7 +23,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"keywords": ["byoc",diff --git a/packages/memory/src/adapter.ts b/packages/memory/src/adapter.tsindex e340b8f..9c0d1b3 100644--- a/packages/memory/src/adapter.ts+++ b/packages/memory/src/adapter.ts@@ -76,7 +76,7 @@ export class MemoryProvider implements BYOCProvider {category: "self-hosted",authentication: "local",supportsUserOwnedStorage: false,- adapterVersion: "0.3.0"+ adapterVersion: "0.4.0"};}diff --git a/packages/provider-sdk/package.json b/packages/provider-sdk/package.jsonindex 1f86c11..ad4bd35 100644--- a/packages/provider-sdk/package.json+++ b/packages/provider-sdk/package.json@@ -1,6 +1,6 @@{"name": "@byoc/provider-sdk",- "version": "0.3.0",+ "version": "0.4.0","description": "BYOC Provider SDK \u2014 Certification suite and developer tools for building BYOC storage adapters","type": "module","main": "./dist/index.js",@@ -17,7 +17,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"keywords": ["byoc",diff --git a/packages/s3-compatible/package.json b/packages/s3-compatible/package.jsonindex c3d27e1..cb8836f 100644--- a/packages/s3-compatible/package.json+++ b/packages/s3-compatible/package.json@@ -1,6 +1,6 @@{"name": "@byoc/s3-compatible",- "version": "0.3.0",+ "version": "0.4.0","description": "Universal S3-compatible storage adapter for Cloudflare R2, AWS S3, MinIO, and Wasabi","type": "module","main": "./dist/index.js",@@ -23,7 +23,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"keywords": ["byoc",diff --git a/packages/s3-compatible/src/adapter.ts b/packages/s3-compatible/src/adapter.tsindex ad9eec2..433c083 100644--- a/packages/s3-compatible/src/adapter.ts+++ b/packages/s3-compatible/src/adapter.ts@@ -50,7 +50,7 @@ export class S3CompatibleProvider implements BYOCProvider {category: "developer-cloud",authentication: "access-key",supportsUserOwnedStorage: false,- adapterVersion: "0.3.0"+ adapterVersion: "0.4.0"};}diff --git a/packages/webdav/package.json b/packages/webdav/package.jsonindex 3de1895..1b74cde 100644--- a/packages/webdav/package.json+++ b/packages/webdav/package.json@@ -1,6 +1,6 @@{"name": "@byoc/webdav",- "version": "0.3.0",+ "version": "0.4.0","description": "Universal WebDAV storage adapter for Nextcloud, ownCloud, and Synology NAS","type": "module","main": "./dist/index.js",@@ -23,7 +23,7 @@"clean": "rm -rf dist tsconfig.tsbuildinfo"},"dependencies": {- "@byoc/core": "^0.3.0"+ "@byoc/core": "^0.4.0"},"keywords": ["byoc",diff --git a/packages/webdav/src/adapter.ts b/packages/webdav/src/adapter.tsindex 95a2401..f92992d 100644--- a/packages/webdav/src/adapter.ts+++ b/packages/webdav/src/adapter.ts@@ -50,7 +50,7 @@ export class WebDAVProvider implements BYOCProvider {category: "self-hosted",authentication: this.config.token ? "oauth2" : "basic",supportsUserOwnedStorage: true,- adapterVersion: "0.3.0"+ adapterVersion: "0.4.0"};}diff --git a/python/pyproject.toml b/python/pyproject.tomlindex 0068438..d7be773 100644--- a/python/pyproject.toml+++ b/python/pyproject.toml@@ -4,7 +4,7 @@ build-backend = "hatchling.build"[project]name = "byoc-storage"-version = "0.3.0"+version = "0.4.0"description = "BYOC (Bring Your Own Cloud) — universal storage abstraction for storage your users already own"readme = "README.md"requires-python = ">=3.10"diff --git a/python/src/byoc/__init__.py b/python/src/byoc/__init__.pyindex 0fec50e..356c7c7 100644--- a/python/src/byoc/__init__.py+++ b/python/src/byoc/__init__.py@@ -75,7 +75,7 @@ from .types import (UploadProgress,)-__version__ = "0.3.0"+__version__ = "0.4.0"__all__ = ["E2EE_MAGIC_HEADER_V3",diff --git a/python/src/byoc/providers/gdrive/adapter.py b/python/src/byoc/providers/gdrive/adapter.pyindex b74de75..9a86ede 100644--- a/python/src/byoc/providers/gdrive/adapter.py+++ b/python/src/byoc/providers/gdrive/adapter.py@@ -92,7 +92,7 @@ class GoogleDriveProvider:category="personal-cloud",authentication="oauth2",supports_user_owned_storage=True,- adapter_version="0.3.0",+ adapter_version="0.4.0",)def capabilities(self) -> ProviderCapabilities:diff --git a/python/src/byoc/providers/local.py b/python/src/byoc/providers/local.pyindex 2f9f412..714a0da 100644--- a/python/src/byoc/providers/local.py+++ b/python/src/byoc/providers/local.py@@ -73,7 +73,7 @@ class LocalFileSystemProvider:category="self-hosted",authentication="local",supports_user_owned_storage=True,- adapter_version="0.3.0",+ adapter_version="0.4.0",)def capabilities(self) -> ProviderCapabilities:diff --git a/python/src/byoc/providers/memory.py b/python/src/byoc/providers/memory.pyindex 6905c00..9a32fa3 100644--- a/python/src/byoc/providers/memory.py+++ b/python/src/byoc/providers/memory.py@@ -82,7 +82,7 @@ class MemoryProvider:category="self-hosted",authentication="local",supports_user_owned_storage=False,- adapter_version="0.3.0",+ adapter_version="0.4.0",)def capabilities(self) -> ProviderCapabilities:diff --git a/python/src/byoc/providers/s3.py b/python/src/byoc/providers/s3.pyindex 18c9efa..2d8ad34 100644--- a/python/src/byoc/providers/s3.py+++ b/python/src/byoc/providers/s3.py@@ -7,6 +7,7 @@ to this module -- BYOC core never sees them.from __future__ import annotations+import contextlibfrom collections.abc import AsyncIterator, Mappingfrom datetime import datetime, timedelta, timezonefrom email.utils import parsedate_to_datetime@@ -125,7 +126,7 @@ class S3CompatibleProvider:category="developer-cloud",authentication="access-key",supports_user_owned_storage=False,- adapter_version="0.3.0",+ adapter_version="0.4.0",)def capabilities(self) -> ProviderCapabilities:@@ -434,12 +435,13 @@ class S3CompatibleProvider:async def _abort_multipart_upload(self, key: str, upload_id: str) -> None:"""Discard a failed upload so its parts stop accruing storage charges."""url = f"{self.object_url(key)}?uploadId={quote(upload_id, safe='')}"- try:+ # Best effort: the upload has already failed, and that failure is what+ # the caller needs to see. Raising from the cleanup would replace a+ # useful error with a confusing one. `suppress` states that intent,+ # where a bare `except: pass` reads like an oversight.+ with contextlib.suppress(Exception):signed = self._sign("DELETE", url)await self._http().request("DELETE", url, headers=signed)- except Exception:- # The original failure is what the caller needs to see, not this.- passasync def _upload_stream(self,diff --git a/python/src/byoc/providers/webdav.py b/python/src/byoc/providers/webdav.pyindex db8455c..c511c25 100644--- a/python/src/byoc/providers/webdav.py+++ b/python/src/byoc/providers/webdav.py@@ -149,7 +149,7 @@ class WebDAVProvider:category="self-hosted",authentication="oauth2" if self.token else "basic",supports_user_owned_storage=True,- adapter_version="0.3.0",+ adapter_version="0.4.0",)def capabilities(self) -> ProviderCapabilities:diff --git a/python/tests/integration/test_s3_minio.py b/python/tests/integration/test_s3_minio.pyindex 4531c3e..206885b 100644--- a/python/tests/integration/test_s3_minio.py+++ b/python/tests/integration/test_s3_minio.py@@ -183,7 +183,7 @@ async def test_presigned_url_is_accepted_by_the_server(provider: S3CompatibleProassert response.content == b"PDF BYTES"+@requires_minioasync def test_streams_an_unknown_length_body_as_multipart(provider: S3CompatibleProvider,) -> None:@@ -215,7 +215,7 @@ async def test_streams_an_unknown_length_body_as_multipart(await provider.delete("streamed/multipart.bin")+@requires_minioasync def test_streams_an_empty_body(provider: S3CompatibleProvider) -> None:"""S3 rejects a zero-part multipart upload, so an empty stream still needs one."""@@ -231,7 +231,7 @@ async def test_streams_an_empty_body(provider: S3CompatibleProvider) -> None:await provider.delete("streamed/empty.bin")+@requires_minioasync def test_a_streamed_upload_reports_progress(provider: S3CompatibleProvider,) -> None: