@backblaze-labs/b2-sdk 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +86 -1
- package/README.md +38 -7
- package/dist/_virtual/_b2-sdk-version-json.cjs +1 -1
- package/dist/_virtual/_b2-sdk-version-json.js +1 -1
- package/dist/auth/file.cjs.map +1 -1
- package/dist/auth/reauth-coalescer.cjs +65 -0
- package/dist/auth/reauth-coalescer.cjs.map +1 -0
- package/dist/auth/reauth-coalescer.d.cts +34 -0
- package/dist/auth/reauth-coalescer.d.cts.map +1 -0
- package/dist/auth/reauth-coalescer.d.ts +34 -0
- package/dist/auth/reauth-coalescer.d.ts.map +1 -0
- package/dist/auth/reauth-coalescer.js +65 -0
- package/dist/auth/reauth-coalescer.js.map +1 -0
- package/dist/backup/client.cjs +206 -0
- package/dist/backup/client.cjs.map +1 -0
- package/dist/backup/client.d.cts +238 -0
- package/dist/backup/client.d.cts.map +1 -0
- package/dist/backup/client.d.ts +238 -0
- package/dist/backup/client.d.ts.map +1 -0
- package/dist/backup/client.js +206 -0
- package/dist/backup/client.js.map +1 -0
- package/dist/backup/index.cjs +15 -0
- package/dist/backup/index.d.cts +22 -0
- package/dist/backup/index.d.cts.map +1 -0
- package/dist/backup/index.d.ts +22 -0
- package/dist/backup/index.d.ts.map +1 -0
- package/dist/backup/index.js +7 -0
- package/dist/backup/raw.cjs +168 -0
- package/dist/backup/raw.cjs.map +1 -0
- package/dist/backup/raw.d.cts +122 -0
- package/dist/backup/raw.d.cts.map +1 -0
- package/dist/backup/raw.d.ts +122 -0
- package/dist/backup/raw.d.ts.map +1 -0
- package/dist/backup/raw.js +168 -0
- package/dist/backup/raw.js.map +1 -0
- package/dist/bucket-validation.cjs +111 -0
- package/dist/bucket-validation.cjs.map +1 -0
- package/dist/bucket-validation.d.cts +27 -0
- package/dist/bucket-validation.d.cts.map +1 -0
- package/dist/bucket-validation.d.ts +27 -0
- package/dist/bucket-validation.d.ts.map +1 -0
- package/dist/bucket-validation.js +109 -0
- package/dist/bucket-validation.js.map +1 -0
- package/dist/bucket.cjs +125 -74
- package/dist/bucket.cjs.map +1 -1
- package/dist/bucket.d.cts +156 -61
- package/dist/bucket.d.cts.map +1 -1
- package/dist/bucket.d.ts +156 -61
- package/dist/bucket.d.ts.map +1 -1
- package/dist/bucket.js +125 -74
- package/dist/bucket.js.map +1 -1
- package/dist/client.cjs +29 -8
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +30 -9
- package/dist/client.d.cts.map +1 -1
- package/dist/client.d.ts +30 -9
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +29 -8
- package/dist/client.js.map +1 -1
- package/dist/copy/large.cjs +5 -3
- package/dist/copy/large.cjs.map +1 -1
- package/dist/copy/large.d.cts.map +1 -1
- package/dist/copy/large.d.ts.map +1 -1
- package/dist/copy/large.js +5 -3
- package/dist/copy/large.js.map +1 -1
- package/dist/download/checksum.cjs +6 -2
- package/dist/download/checksum.cjs.map +1 -1
- package/dist/download/checksum.js +6 -2
- package/dist/download/checksum.js.map +1 -1
- package/dist/download/parallel.cjs +52 -15
- package/dist/download/parallel.cjs.map +1 -1
- package/dist/download/parallel.d.cts +8 -1
- package/dist/download/parallel.d.cts.map +1 -1
- package/dist/download/parallel.d.ts +8 -1
- package/dist/download/parallel.d.ts.map +1 -1
- package/dist/download/parallel.js +52 -15
- package/dist/download/parallel.js.map +1 -1
- package/dist/download/single.cjs +179 -19
- package/dist/download/single.cjs.map +1 -1
- package/dist/download/single.d.cts +10 -4
- package/dist/download/single.d.cts.map +1 -1
- package/dist/download/single.d.ts +10 -4
- package/dist/download/single.d.ts.map +1 -1
- package/dist/download/single.js +179 -19
- package/dist/download/single.js.map +1 -1
- package/dist/errors/index.cjs +196 -3
- package/dist/errors/index.cjs.map +1 -1
- package/dist/errors/index.d.cts +134 -0
- package/dist/errors/index.d.cts.map +1 -1
- package/dist/errors/index.d.ts +134 -0
- package/dist/errors/index.d.ts.map +1 -1
- package/dist/errors/index.js +183 -4
- package/dist/errors/index.js.map +1 -1
- package/dist/http/non-idempotent-mutations.cjs +38 -0
- package/dist/http/non-idempotent-mutations.cjs.map +1 -0
- package/dist/http/non-idempotent-mutations.d.cts +25 -0
- package/dist/http/non-idempotent-mutations.d.cts.map +1 -0
- package/dist/http/non-idempotent-mutations.d.ts +25 -0
- package/dist/http/non-idempotent-mutations.d.ts.map +1 -0
- package/dist/http/non-idempotent-mutations.js +35 -0
- package/dist/http/non-idempotent-mutations.js.map +1 -0
- package/dist/http/retry.cjs +1 -1
- package/dist/http/retry.cjs.map +1 -1
- package/dist/http/retry.js +1 -1
- package/dist/http/retry.js.map +1 -1
- package/dist/http/transport.cjs +62 -23
- package/dist/http/transport.cjs.map +1 -1
- package/dist/http/transport.d.cts +30 -3
- package/dist/http/transport.d.cts.map +1 -1
- package/dist/http/transport.d.ts +30 -3
- package/dist/http/transport.d.ts.map +1 -1
- package/dist/http/transport.js +60 -22
- package/dist/http/transport.js.map +1 -1
- package/dist/http/user-agent.cjs +12 -1
- package/dist/http/user-agent.cjs.map +1 -1
- package/dist/http/user-agent.d.cts +8 -0
- package/dist/http/user-agent.d.cts.map +1 -1
- package/dist/http/user-agent.d.ts +8 -0
- package/dist/http/user-agent.d.ts.map +1 -1
- package/dist/http/user-agent.js +13 -3
- package/dist/http/user-agent.js.map +1 -1
- package/dist/index.cjs +50 -2
- package/dist/index.d.cts +15 -12
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.ts +15 -12
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +13 -10
- package/dist/notifications/index.cjs +3 -0
- package/dist/notifications/index.d.cts +2 -0
- package/dist/notifications/index.d.cts.map +1 -1
- package/dist/notifications/index.d.ts +2 -0
- package/dist/notifications/index.d.ts.map +1 -1
- package/dist/notifications/index.js +2 -1
- package/dist/object.cjs +13 -2
- package/dist/object.cjs.map +1 -1
- package/dist/object.d.cts +11 -3
- package/dist/object.d.cts.map +1 -1
- package/dist/object.d.ts +11 -3
- package/dist/object.d.ts.map +1 -1
- package/dist/object.js +13 -2
- package/dist/object.js.map +1 -1
- package/dist/partner/account-info.d.cts +43 -0
- package/dist/partner/account-info.d.cts.map +1 -0
- package/dist/partner/account-info.d.ts +43 -0
- package/dist/partner/account-info.d.ts.map +1 -0
- package/dist/partner/auth-clone.cjs +64 -0
- package/dist/partner/auth-clone.cjs.map +1 -0
- package/dist/partner/auth-clone.d.cts +27 -0
- package/dist/partner/auth-clone.d.cts.map +1 -0
- package/dist/partner/auth-clone.d.ts +27 -0
- package/dist/partner/auth-clone.d.ts.map +1 -0
- package/dist/partner/auth-clone.js +63 -0
- package/dist/partner/auth-clone.js.map +1 -0
- package/dist/partner/auth-core.cjs +156 -0
- package/dist/partner/auth-core.cjs.map +1 -0
- package/dist/partner/auth-core.d.cts +111 -0
- package/dist/partner/auth-core.d.cts.map +1 -0
- package/dist/partner/auth-core.d.ts +111 -0
- package/dist/partner/auth-core.d.ts.map +1 -0
- package/dist/partner/auth-core.js +156 -0
- package/dist/partner/auth-core.js.map +1 -0
- package/dist/partner/auth-shape.cjs +36 -0
- package/dist/partner/auth-shape.cjs.map +1 -0
- package/dist/partner/auth-shape.d.cts +12 -0
- package/dist/partner/auth-shape.d.cts.map +1 -0
- package/dist/partner/auth-shape.d.ts +12 -0
- package/dist/partner/auth-shape.d.ts.map +1 -0
- package/dist/partner/auth-shape.js +36 -0
- package/dist/partner/auth-shape.js.map +1 -0
- package/dist/partner/client.cjs +270 -0
- package/dist/partner/client.cjs.map +1 -0
- package/dist/partner/client.d.cts +357 -0
- package/dist/partner/client.d.cts.map +1 -0
- package/dist/partner/client.d.ts +357 -0
- package/dist/partner/client.d.ts.map +1 -0
- package/dist/partner/client.js +270 -0
- package/dist/partner/client.js.map +1 -0
- package/dist/partner/endpoint-url.cjs +109 -0
- package/dist/partner/endpoint-url.cjs.map +1 -0
- package/dist/partner/endpoint-url.d.cts +74 -0
- package/dist/partner/endpoint-url.d.cts.map +1 -0
- package/dist/partner/endpoint-url.d.ts +74 -0
- package/dist/partner/endpoint-url.d.ts.map +1 -0
- package/dist/partner/endpoint-url.js +106 -0
- package/dist/partner/endpoint-url.js.map +1 -0
- package/dist/partner/in-memory.cjs +135 -0
- package/dist/partner/in-memory.cjs.map +1 -0
- package/dist/partner/in-memory.d.cts +99 -0
- package/dist/partner/in-memory.d.cts.map +1 -0
- package/dist/partner/in-memory.d.ts +99 -0
- package/dist/partner/in-memory.d.ts.map +1 -0
- package/dist/partner/in-memory.js +135 -0
- package/dist/partner/in-memory.js.map +1 -0
- package/dist/partner/index.cjs +27 -0
- package/dist/partner/index.d.cts +32 -0
- package/dist/partner/index.d.cts.map +1 -0
- package/dist/partner/index.d.ts +32 -0
- package/dist/partner/index.d.ts.map +1 -0
- package/dist/partner/index.js +9 -0
- package/dist/partner/raw.cjs +400 -0
- package/dist/partner/raw.cjs.map +1 -0
- package/dist/partner/raw.d.cts +220 -0
- package/dist/partner/raw.d.cts.map +1 -0
- package/dist/partner/raw.d.ts +220 -0
- package/dist/partner/raw.d.ts.map +1 -0
- package/dist/partner/raw.js +398 -0
- package/dist/partner/raw.js.map +1 -0
- package/dist/partner/redaction-placeholders.cjs +10 -0
- package/dist/partner/redaction-placeholders.cjs.map +1 -0
- package/dist/partner/redaction-placeholders.d.cts +5 -0
- package/dist/partner/redaction-placeholders.d.cts.map +1 -0
- package/dist/partner/redaction-placeholders.d.ts +5 -0
- package/dist/partner/redaction-placeholders.d.ts.map +1 -0
- package/dist/partner/redaction-placeholders.js +9 -0
- package/dist/partner/redaction-placeholders.js.map +1 -0
- package/dist/partner/redaction.cjs +292 -0
- package/dist/partner/redaction.cjs.map +1 -0
- package/dist/partner/redaction.d.cts +158 -0
- package/dist/partner/redaction.d.cts.map +1 -0
- package/dist/partner/redaction.d.ts +158 -0
- package/dist/partner/redaction.d.ts.map +1 -0
- package/dist/partner/redaction.js +281 -0
- package/dist/partner/redaction.js.map +1 -0
- package/dist/raw/encoding.cjs +29 -10
- package/dist/raw/encoding.cjs.map +1 -1
- package/dist/raw/encoding.d.cts +3 -2
- package/dist/raw/encoding.d.cts.map +1 -1
- package/dist/raw/encoding.d.ts +3 -2
- package/dist/raw/encoding.d.ts.map +1 -1
- package/dist/raw/encoding.js +29 -10
- package/dist/raw/encoding.js.map +1 -1
- package/dist/raw/index.cjs +131 -44
- package/dist/raw/index.cjs.map +1 -1
- package/dist/raw/index.d.cts +21 -15
- package/dist/raw/index.d.cts.map +1 -1
- package/dist/raw/index.d.ts +21 -15
- package/dist/raw/index.d.ts.map +1 -1
- package/dist/raw/index.js +114 -45
- package/dist/raw/index.js.map +1 -1
- package/dist/raw/url.cjs +111 -0
- package/dist/raw/url.cjs.map +1 -0
- package/dist/raw/url.d.cts +41 -0
- package/dist/raw/url.d.cts.map +1 -0
- package/dist/raw/url.d.ts +41 -0
- package/dist/raw/url.d.ts.map +1 -0
- package/dist/raw/url.js +110 -0
- package/dist/raw/url.js.map +1 -0
- package/dist/s3/sigv4.cjs +15 -10
- package/dist/s3/sigv4.cjs.map +1 -1
- package/dist/s3/sigv4.js +15 -10
- package/dist/s3/sigv4.js.map +1 -1
- package/dist/simulator/index.cjs +1579 -257
- package/dist/simulator/index.cjs.map +1 -1
- package/dist/simulator/index.d.cts +124 -11
- package/dist/simulator/index.d.cts.map +1 -1
- package/dist/simulator/index.d.ts +124 -11
- package/dist/simulator/index.d.ts.map +1 -1
- package/dist/simulator/index.js +1568 -262
- package/dist/simulator/index.js.map +1 -1
- package/dist/simulator/partner-capabilities.cjs +77 -0
- package/dist/simulator/partner-capabilities.cjs.map +1 -0
- package/dist/simulator/partner-capabilities.d.cts +53 -0
- package/dist/simulator/partner-capabilities.d.cts.map +1 -0
- package/dist/simulator/partner-capabilities.d.ts +53 -0
- package/dist/simulator/partner-capabilities.d.ts.map +1 -0
- package/dist/simulator/partner-capabilities.js +73 -0
- package/dist/simulator/partner-capabilities.js.map +1 -0
- package/dist/simulator/partner.cjs +713 -0
- package/dist/simulator/partner.cjs.map +1 -0
- package/dist/simulator/partner.d.cts +186 -0
- package/dist/simulator/partner.d.cts.map +1 -0
- package/dist/simulator/partner.d.ts +186 -0
- package/dist/simulator/partner.d.ts.map +1 -0
- package/dist/simulator/partner.js +713 -0
- package/dist/simulator/partner.js.map +1 -0
- package/dist/simulator/validation.cjs +732 -25
- package/dist/simulator/validation.cjs.map +1 -1
- package/dist/simulator/validation.d.cts +145 -6
- package/dist/simulator/validation.d.cts.map +1 -1
- package/dist/simulator/validation.d.ts +145 -6
- package/dist/simulator/validation.d.ts.map +1 -1
- package/dist/simulator/validation.js +705 -26
- package/dist/simulator/validation.js.map +1 -1
- package/dist/streams/file-source.cjs +2 -2
- package/dist/streams/file-source.cjs.map +1 -1
- package/dist/streams/file-source.js +2 -2
- package/dist/streams/file-source.js.map +1 -1
- package/dist/streams/hash.cjs +246 -13
- package/dist/streams/hash.cjs.map +1 -1
- package/dist/streams/hash.d.cts +37 -12
- package/dist/streams/hash.d.cts.map +1 -1
- package/dist/streams/hash.d.ts +37 -12
- package/dist/streams/hash.d.ts.map +1 -1
- package/dist/streams/hash.js +246 -15
- package/dist/streams/hash.js.map +1 -1
- package/dist/streams/index.cjs +3 -1
- package/dist/streams/index.d.cts +1 -1
- package/dist/streams/index.d.cts.map +1 -1
- package/dist/streams/index.d.ts +1 -1
- package/dist/streams/index.d.ts.map +1 -1
- package/dist/streams/index.js +3 -3
- package/dist/streams/progress.cjs +63 -4
- package/dist/streams/progress.cjs.map +1 -1
- package/dist/streams/progress.d.cts +28 -2
- package/dist/streams/progress.d.cts.map +1 -1
- package/dist/streams/progress.d.ts +28 -2
- package/dist/streams/progress.d.ts.map +1 -1
- package/dist/streams/progress.js +63 -4
- package/dist/streams/progress.js.map +1 -1
- package/dist/streams/source.cjs +2 -1
- package/dist/streams/source.cjs.map +1 -1
- package/dist/streams/source.js +2 -1
- package/dist/streams/source.js.map +1 -1
- package/dist/sync/b2-sha1-reader.cjs +6 -2
- package/dist/sync/b2-sha1-reader.cjs.map +1 -1
- package/dist/sync/b2-sha1-reader.d.cts.map +1 -1
- package/dist/sync/b2-sha1-reader.d.ts.map +1 -1
- package/dist/sync/b2-sha1-reader.js +6 -2
- package/dist/sync/b2-sha1-reader.js.map +1 -1
- package/dist/sync/download-staging.cjs +156 -43
- package/dist/sync/download-staging.cjs.map +1 -1
- package/dist/sync/download-staging.d.cts +26 -2
- package/dist/sync/download-staging.d.cts.map +1 -1
- package/dist/sync/download-staging.d.ts +26 -2
- package/dist/sync/download-staging.d.ts.map +1 -1
- package/dist/sync/download-staging.js +155 -44
- package/dist/sync/download-staging.js.map +1 -1
- package/dist/sync/filters.cjs.map +1 -1
- package/dist/sync/filters.js.map +1 -1
- package/dist/sync/index.d.cts +1 -1
- package/dist/sync/index.d.cts.map +1 -1
- package/dist/sync/index.d.ts +1 -1
- package/dist/sync/index.d.ts.map +1 -1
- package/dist/sync/local-file-io.cjs +15 -6
- package/dist/sync/local-file-io.cjs.map +1 -1
- package/dist/sync/local-file-io.d.cts +3 -0
- package/dist/sync/local-file-io.d.cts.map +1 -1
- package/dist/sync/local-file-io.d.ts +3 -0
- package/dist/sync/local-file-io.d.ts.map +1 -1
- package/dist/sync/local-file-io.js +15 -6
- package/dist/sync/local-file-io.js.map +1 -1
- package/dist/sync/local-sha1.cjs +6 -15
- package/dist/sync/local-sha1.cjs.map +1 -1
- package/dist/sync/local-sha1.d.cts +0 -8
- package/dist/sync/local-sha1.d.cts.map +1 -1
- package/dist/sync/local-sha1.d.ts +0 -8
- package/dist/sync/local-sha1.d.ts.map +1 -1
- package/dist/sync/local-sha1.js +7 -15
- package/dist/sync/local-sha1.js.map +1 -1
- package/dist/sync/pairing.cjs +1 -0
- package/dist/sync/pairing.cjs.map +1 -1
- package/dist/sync/pairing.js +1 -0
- package/dist/sync/pairing.js.map +1 -1
- package/dist/sync/policies/compare.cjs +5 -3
- package/dist/sync/policies/compare.cjs.map +1 -1
- package/dist/sync/policies/compare.d.cts.map +1 -1
- package/dist/sync/policies/compare.d.ts.map +1 -1
- package/dist/sync/policies/compare.js +6 -4
- package/dist/sync/policies/compare.js.map +1 -1
- package/dist/sync/policies/index.cjs +4 -10
- package/dist/sync/policies/index.cjs.map +1 -1
- package/dist/sync/policies/index.js +4 -10
- package/dist/sync/policies/index.js.map +1 -1
- package/dist/sync/scanners/b2.cjs +4 -2
- package/dist/sync/scanners/b2.cjs.map +1 -1
- package/dist/sync/scanners/b2.d.cts.map +1 -1
- package/dist/sync/scanners/b2.d.ts.map +1 -1
- package/dist/sync/scanners/b2.js +4 -2
- package/dist/sync/scanners/b2.js.map +1 -1
- package/dist/sync/scanners/local.cjs +150 -33
- package/dist/sync/scanners/local.cjs.map +1 -1
- package/dist/sync/scanners/local.d.cts +6 -0
- package/dist/sync/scanners/local.d.cts.map +1 -1
- package/dist/sync/scanners/local.d.ts +6 -0
- package/dist/sync/scanners/local.d.ts.map +1 -1
- package/dist/sync/scanners/local.js +150 -33
- package/dist/sync/scanners/local.js.map +1 -1
- package/dist/sync/synchronizer.cjs +79 -31
- package/dist/sync/synchronizer.cjs.map +1 -1
- package/dist/sync/synchronizer.d.cts +1 -0
- package/dist/sync/synchronizer.d.cts.map +1 -1
- package/dist/sync/synchronizer.d.ts +1 -0
- package/dist/sync/synchronizer.d.ts.map +1 -1
- package/dist/sync/synchronizer.js +79 -31
- package/dist/sync/synchronizer.js.map +1 -1
- package/dist/sync/types.d.cts +19 -3
- package/dist/sync/types.d.cts.map +1 -1
- package/dist/sync/types.d.ts +19 -3
- package/dist/sync/types.d.ts.map +1 -1
- package/dist/types/auth.cjs +4 -0
- package/dist/types/auth.cjs.map +1 -1
- package/dist/types/auth.d.cts +4 -0
- package/dist/types/auth.d.cts.map +1 -1
- package/dist/types/auth.d.ts +4 -0
- package/dist/types/auth.d.ts.map +1 -1
- package/dist/types/auth.js +4 -0
- package/dist/types/auth.js.map +1 -1
- package/dist/types/backup.d.cts +85 -0
- package/dist/types/backup.d.cts.map +1 -0
- package/dist/types/backup.d.ts +85 -0
- package/dist/types/backup.d.ts.map +1 -0
- package/dist/types/bucket.cjs +81 -11
- package/dist/types/bucket.cjs.map +1 -1
- package/dist/types/bucket.d.cts +194 -41
- package/dist/types/bucket.d.cts.map +1 -1
- package/dist/types/bucket.d.ts +194 -41
- package/dist/types/bucket.d.ts.map +1 -1
- package/dist/types/bucket.js +67 -12
- package/dist/types/bucket.js.map +1 -1
- package/dist/types/download.cjs +62 -0
- package/dist/types/download.cjs.map +1 -0
- package/dist/types/download.d.cts +100 -16
- package/dist/types/download.d.cts.map +1 -1
- package/dist/types/download.d.ts +100 -16
- package/dist/types/download.d.ts.map +1 -1
- package/dist/types/download.js +61 -0
- package/dist/types/download.js.map +1 -0
- package/dist/types/encryption.cjs +76 -229
- package/dist/types/encryption.cjs.map +1 -1
- package/dist/types/encryption.d.cts +48 -6
- package/dist/types/encryption.d.cts.map +1 -1
- package/dist/types/encryption.d.ts +48 -6
- package/dist/types/encryption.d.ts.map +1 -1
- package/dist/types/encryption.js +74 -229
- package/dist/types/encryption.js.map +1 -1
- package/dist/types/errors.cjs +9 -0
- package/dist/types/errors.cjs.map +1 -1
- package/dist/types/errors.d.cts +1 -1
- package/dist/types/errors.d.cts.map +1 -1
- package/dist/types/errors.d.ts +1 -1
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +9 -0
- package/dist/types/errors.js.map +1 -1
- package/dist/types/file.cjs +3 -0
- package/dist/types/file.cjs.map +1 -1
- package/dist/types/file.d.cts +140 -18
- package/dist/types/file.d.cts.map +1 -1
- package/dist/types/file.d.ts +140 -18
- package/dist/types/file.d.ts.map +1 -1
- package/dist/types/file.js +3 -1
- package/dist/types/file.js.map +1 -1
- package/dist/types/ids.cjs +30 -0
- package/dist/types/ids.cjs.map +1 -1
- package/dist/types/ids.d.cts +32 -0
- package/dist/types/ids.d.cts.map +1 -1
- package/dist/types/ids.d.ts +32 -0
- package/dist/types/ids.d.ts.map +1 -1
- package/dist/types/ids.js +28 -1
- package/dist/types/ids.js.map +1 -1
- package/dist/types/index.d.cts +16 -12
- package/dist/types/index.d.cts.map +1 -1
- package/dist/types/index.d.ts +16 -12
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/key.d.cts +4 -3
- package/dist/types/key.d.cts.map +1 -1
- package/dist/types/key.d.ts +4 -3
- package/dist/types/key.d.ts.map +1 -1
- package/dist/types/lock.cjs.map +1 -1
- package/dist/types/lock.d.cts +14 -0
- package/dist/types/lock.d.cts.map +1 -1
- package/dist/types/lock.d.ts +14 -0
- package/dist/types/lock.d.ts.map +1 -1
- package/dist/types/lock.js.map +1 -1
- package/dist/types/notifications.cjs +31 -1
- package/dist/types/notifications.cjs.map +1 -1
- package/dist/types/notifications.d.cts +31 -4
- package/dist/types/notifications.d.cts.map +1 -1
- package/dist/types/notifications.d.ts +31 -4
- package/dist/types/notifications.d.ts.map +1 -1
- package/dist/types/notifications.js +30 -2
- package/dist/types/notifications.js.map +1 -1
- package/dist/types/partner.cjs +32 -0
- package/dist/types/partner.cjs.map +1 -0
- package/dist/types/partner.d.cts +386 -0
- package/dist/types/partner.d.cts.map +1 -0
- package/dist/types/partner.d.ts +386 -0
- package/dist/types/partner.d.ts.map +1 -0
- package/dist/types/partner.js +29 -0
- package/dist/types/partner.js.map +1 -0
- package/dist/types/upload.d.cts +35 -18
- package/dist/types/upload.d.cts.map +1 -1
- package/dist/types/upload.d.ts +35 -18
- package/dist/types/upload.d.ts.map +1 -1
- package/dist/upload/abort-scope.cjs +0 -45
- package/dist/upload/abort-scope.cjs.map +1 -1
- package/dist/upload/abort-scope.d.cts +0 -22
- package/dist/upload/abort-scope.d.cts.map +1 -1
- package/dist/upload/abort-scope.d.ts +0 -22
- package/dist/upload/abort-scope.d.ts.map +1 -1
- package/dist/upload/abort-scope.js +1 -44
- package/dist/upload/abort-scope.js.map +1 -1
- package/dist/upload/finish.cjs +3 -8
- package/dist/upload/finish.cjs.map +1 -1
- package/dist/upload/finish.d.cts.map +1 -1
- package/dist/upload/finish.d.ts.map +1 -1
- package/dist/upload/finish.js +1 -6
- package/dist/upload/finish.js.map +1 -1
- package/dist/upload/large.cjs +15 -8
- package/dist/upload/large.cjs.map +1 -1
- package/dist/upload/large.d.cts +31 -8
- package/dist/upload/large.d.cts.map +1 -1
- package/dist/upload/large.d.ts +31 -8
- package/dist/upload/large.d.ts.map +1 -1
- package/dist/upload/large.js +15 -8
- package/dist/upload/large.js.map +1 -1
- package/dist/upload/options.cjs.map +1 -1
- package/dist/upload/options.d.cts +24 -0
- package/dist/upload/options.d.cts.map +1 -1
- package/dist/upload/options.d.ts +24 -0
- package/dist/upload/options.d.ts.map +1 -1
- package/dist/upload/options.js.map +1 -1
- package/dist/upload/resume.cjs +6 -4
- package/dist/upload/resume.cjs.map +1 -1
- package/dist/upload/resume.d.cts +9 -5
- package/dist/upload/resume.d.cts.map +1 -1
- package/dist/upload/resume.d.ts +9 -5
- package/dist/upload/resume.d.ts.map +1 -1
- package/dist/upload/resume.js +6 -4
- package/dist/upload/resume.js.map +1 -1
- package/dist/upload/retry.cjs +25 -13
- package/dist/upload/retry.cjs.map +1 -1
- package/dist/upload/retry.d.cts.map +1 -1
- package/dist/upload/retry.d.ts.map +1 -1
- package/dist/upload/retry.js +25 -13
- package/dist/upload/retry.js.map +1 -1
- package/dist/upload/single.cjs +35 -30
- package/dist/upload/single.cjs.map +1 -1
- package/dist/upload/single.d.cts +12 -0
- package/dist/upload/single.d.cts.map +1 -1
- package/dist/upload/single.d.ts +12 -0
- package/dist/upload/single.d.ts.map +1 -1
- package/dist/upload/single.js +35 -30
- package/dist/upload/single.js.map +1 -1
- package/dist/upload/stream.cjs +18 -5
- package/dist/upload/stream.cjs.map +1 -1
- package/dist/upload/stream.d.cts +12 -0
- package/dist/upload/stream.d.cts.map +1 -1
- package/dist/upload/stream.d.ts +12 -0
- package/dist/upload/stream.d.ts.map +1 -1
- package/dist/upload/stream.js +15 -2
- package/dist/upload/stream.js.map +1 -1
- package/dist/util/abort.cjs +114 -0
- package/dist/util/abort.cjs.map +1 -0
- package/dist/util/abort.d.cts +65 -0
- package/dist/util/abort.d.cts.map +1 -0
- package/dist/util/abort.d.ts +65 -0
- package/dist/util/abort.d.ts.map +1 -0
- package/dist/util/abort.js +109 -0
- package/dist/util/abort.js.map +1 -0
- package/dist/util/defaults.cjs +3 -0
- package/dist/util/defaults.cjs.map +1 -1
- package/dist/util/defaults.d.cts +2 -0
- package/dist/util/defaults.d.cts.map +1 -1
- package/dist/util/defaults.d.ts +2 -0
- package/dist/util/defaults.d.ts.map +1 -1
- package/dist/util/defaults.js +3 -1
- package/dist/util/defaults.js.map +1 -1
- package/dist/util/md5.cjs +211 -0
- package/dist/util/md5.cjs.map +1 -0
- package/dist/util/md5.d.cts +43 -0
- package/dist/util/md5.d.cts.map +1 -0
- package/dist/util/md5.d.ts +43 -0
- package/dist/util/md5.d.ts.map +1 -0
- package/dist/util/md5.js +209 -0
- package/dist/util/md5.js.map +1 -0
- package/dist/util/normalize.cjs +5 -5
- package/dist/util/normalize.cjs.map +1 -1
- package/dist/util/normalize.d.cts +7 -7
- package/dist/util/normalize.d.cts.map +1 -1
- package/dist/util/normalize.d.ts +7 -7
- package/dist/util/normalize.d.ts.map +1 -1
- package/dist/util/normalize.js +5 -5
- package/dist/util/normalize.js.map +1 -1
- package/dist/util/paginator.cjs +7 -1
- package/dist/util/paginator.cjs.map +1 -1
- package/dist/util/paginator.d.cts +3 -1
- package/dist/util/paginator.d.cts.map +1 -1
- package/dist/util/paginator.d.ts +3 -1
- package/dist/util/paginator.d.ts.map +1 -1
- package/dist/util/paginator.js +7 -1
- package/dist/util/paginator.js.map +1 -1
- package/dist/version.cjs +56 -4
- package/dist/version.cjs.map +1 -1
- package/dist/version.d.cts +53 -4
- package/dist/version.d.cts.map +1 -1
- package/dist/version.d.ts +53 -4
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +52 -5
- package/dist/version.js.map +1 -1
- package/package.json +47 -18
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { RetryOptions } from '../http/retry.js';
|
|
2
|
+
import { HttpTransport } from '../http/transport.js';
|
|
3
|
+
import { CreateGroupMemberRequest, CreateGroupMemberResponse, EjectGroupMemberRequest, EjectGroupMemberResponse, ListGroupMembersRequest, ListGroupMembersResponse, ListGroupsRequest, ListGroupsResponse, PartnerAuthorizeResponse, ReserveTrialCreateAccountRequest, ReserveTrialCreateAccountResponse } from '../types/partner.js';
|
|
4
|
+
/** Configuration for constructing a {@link PartnerRawClient}. */
|
|
5
|
+
export interface PartnerRawClientOptions {
|
|
6
|
+
/**
|
|
7
|
+
* The HTTP transport used to send requests.
|
|
8
|
+
*
|
|
9
|
+
* Partner endpoint calls validate URLs against suffixes recorded by
|
|
10
|
+
* `authorizePartner()`. A rehydrated client that skips authorization must use
|
|
11
|
+
* `authorizedPartnerEndpointSuffixes` or a {@link UrlGuardedTransport} with a
|
|
12
|
+
* locked `urlGuard`. Because Partner authorize responses redact
|
|
13
|
+
* `authorizationToken` under `JSON.stringify`, durable caches should persist
|
|
14
|
+
* `partnerAuthorizeResponseForPersistence(auth)` only to encrypted or
|
|
15
|
+
* otherwise credential-grade storage, or use another secure token-preserving
|
|
16
|
+
* representation.
|
|
17
|
+
*/
|
|
18
|
+
readonly transport: HttpTransport;
|
|
19
|
+
/**
|
|
20
|
+
* Validated Partner endpoint host suffixes restored from cached
|
|
21
|
+
* authorization. Facades normally manage this after authorization; direct raw
|
|
22
|
+
* clients can pass suffixes derived from trusted Partner authorization when
|
|
23
|
+
* rehydrating an auth cache. Do not derive this cache with
|
|
24
|
+
* `JSON.stringify(authorizePartner())`, which intentionally stores a redacted
|
|
25
|
+
* token placeholder instead of a usable Partner token. Rehydrating that
|
|
26
|
+
* placeholder fails fast.
|
|
27
|
+
*/
|
|
28
|
+
readonly authorizedPartnerEndpointSuffixes?: readonly string[];
|
|
29
|
+
/**
|
|
30
|
+
* Allow direct custom authorize realms for tests or private proxies.
|
|
31
|
+
* Leave disabled unless the configured host is trusted with the Master Application Key.
|
|
32
|
+
*/
|
|
33
|
+
readonly allowCustomAuthorizeRealm?: boolean;
|
|
34
|
+
}
|
|
35
|
+
/** Optional controls for raw Partner API requests. */
|
|
36
|
+
export interface PartnerRawRequestOptions {
|
|
37
|
+
/** Abort signal for cancelling the request. */
|
|
38
|
+
readonly signal?: AbortSignal;
|
|
39
|
+
/** Per-request retry override. */
|
|
40
|
+
readonly retry?: Partial<RetryOptions>;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Derives the Partner authorize and endpoint host suffixes that may receive
|
|
44
|
+
* Partner tokens after a trusted authorize response has been validated.
|
|
45
|
+
*
|
|
46
|
+
* @param auth - Normalized Partner authorize response.
|
|
47
|
+
* @param realmUrl - Realm URL used for Partner authorization.
|
|
48
|
+
*
|
|
49
|
+
* @returns Sorted list of unique host suffixes to allow.
|
|
50
|
+
*
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
export declare function derivePartnerAllowedSuffixes(auth: PartnerAuthorizeResponse, realmUrl: string): readonly string[];
|
|
54
|
+
/**
|
|
55
|
+
* Validates cached Partner authorize endpoint URLs with the same realm policy
|
|
56
|
+
* applied to fresh `authorizePartner()` responses and returns guard suffixes.
|
|
57
|
+
*
|
|
58
|
+
* @param auth - Cached Partner authorize response to validate.
|
|
59
|
+
* @param realmUrl - Realm URL used for Partner authorization.
|
|
60
|
+
* @param allowCustomAuthorizeRealm - Whether custom authorize realms are trusted.
|
|
61
|
+
*
|
|
62
|
+
* @returns Sorted list of host suffixes derived from the validated auth state.
|
|
63
|
+
*
|
|
64
|
+
* @throws B2PartnerAuthorizationError if the cached auth endpoints are unsafe.
|
|
65
|
+
*
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
export declare function validatePartnerAuthorizeResponseEndpoints(auth: PartnerAuthorizeResponse, realmUrl: string, allowCustomAuthorizeRealm: boolean): readonly string[];
|
|
69
|
+
/**
|
|
70
|
+
* Low-level client for Partner API authorization and endpoint bindings.
|
|
71
|
+
*/
|
|
72
|
+
export declare class PartnerRawClient {
|
|
73
|
+
/** @internal */
|
|
74
|
+
private readonly transport;
|
|
75
|
+
private readonly allowCustomAuthorizeRealm;
|
|
76
|
+
private authorizedEndpointSuffixes;
|
|
77
|
+
/**
|
|
78
|
+
* Creates a new PartnerRawClient with the given transport.
|
|
79
|
+
*
|
|
80
|
+
* @param options - The constructor configuration.
|
|
81
|
+
*/
|
|
82
|
+
constructor(options: PartnerRawClientOptions);
|
|
83
|
+
/**
|
|
84
|
+
* Replaces the validated Partner endpoint host suffixes.
|
|
85
|
+
*
|
|
86
|
+
* @param suffixes - Host suffixes derived from Partner authorization.
|
|
87
|
+
*
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
setAuthorizedEndpointSuffixes(suffixes: readonly string[]): void;
|
|
91
|
+
/**
|
|
92
|
+
* Calls `b2_authorize_account` with Master Application Key credentials and
|
|
93
|
+
* normalizes the Partner/Backup suites into a Partner-specific auth shape.
|
|
94
|
+
*
|
|
95
|
+
* The Partner API documentation currently shows the v3 authorize path, so
|
|
96
|
+
* this method intentionally uses `/b2api/v3/b2_authorize_account` while the
|
|
97
|
+
* storage raw client keeps using v4.
|
|
98
|
+
*
|
|
99
|
+
* @param masterKeyId - The Master Application Key ID for authentication.
|
|
100
|
+
* @param masterKey - The Master Application Key secret.
|
|
101
|
+
* @param realmUrl - The B2 realm URL to authenticate against.
|
|
102
|
+
* @param options - Optional abort and per-request retry settings.
|
|
103
|
+
*
|
|
104
|
+
* @returns The normalized Partner authorization response.
|
|
105
|
+
*
|
|
106
|
+
* @throws B2RealmConfigurationError if the realm URL is unsafe for Master Application Key credentials.
|
|
107
|
+
* @throws B2PartnerAuthorizationError if the response omits or returns unsafe Partner endpoint data.
|
|
108
|
+
*/
|
|
109
|
+
authorizePartner(masterKeyId: string, masterKey: string, realmUrl?: string, options?: PartnerRawRequestOptions): Promise<PartnerAuthorizeResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-create-group-member | b2_create_group_member}.
|
|
112
|
+
*
|
|
113
|
+
* The Partner API creates a new Backblaze account for an email address that
|
|
114
|
+
* is not already a Backblaze account and adds that account to the managed
|
|
115
|
+
* group. The wire response is a single JSON object.
|
|
116
|
+
*
|
|
117
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
118
|
+
* @param authToken - The Partner API authorization token.
|
|
119
|
+
* @param request - The group-member creation request body.
|
|
120
|
+
* @param options - Optional abort and per-request retry settings.
|
|
121
|
+
*
|
|
122
|
+
* @returns The created member result, including the member application key.
|
|
123
|
+
*/
|
|
124
|
+
createGroupMember(groupsApiUrl: string, authToken: string, request: CreateGroupMemberRequest, options?: PartnerRawRequestOptions): Promise<CreateGroupMemberResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-eject-group-member | b2_eject_group_member}.
|
|
127
|
+
*
|
|
128
|
+
* Ejection removes the member account from the group but does not delete the
|
|
129
|
+
* Backblaze account. The wire response is a single JSON object.
|
|
130
|
+
*
|
|
131
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
132
|
+
* @param authToken - The Partner API authorization token.
|
|
133
|
+
* @param request - The group-member ejection request body.
|
|
134
|
+
* @param options - Optional abort and per-request retry settings.
|
|
135
|
+
*
|
|
136
|
+
* @returns The ejected member object.
|
|
137
|
+
*/
|
|
138
|
+
ejectGroupMember(groupsApiUrl: string, authToken: string, request: EjectGroupMemberRequest, options?: PartnerRawRequestOptions): Promise<EjectGroupMemberResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-reserve-trial-create-account | b2_reserve_trial_create_account}.
|
|
141
|
+
*
|
|
142
|
+
* The Partner API creates one new Backblaze B2 account and starts a B2
|
|
143
|
+
* Reserve trial for it. The wire request and success response are single
|
|
144
|
+
* JSON objects.
|
|
145
|
+
*
|
|
146
|
+
* Each email address must not already be a Backblaze account. `term` is the
|
|
147
|
+
* trial duration in days, documented as 7 through 30 inclusive. `storage` is
|
|
148
|
+
* the requested storage in TB, documented as 1 through 50 inclusive.
|
|
149
|
+
*
|
|
150
|
+
* This operation is non-idempotent and creates billable accounts. Automatic
|
|
151
|
+
* retries and expired-token reauthorization are disabled; long-lived
|
|
152
|
+
* callers must catch auth expiry, reauthorize, and then decide whether to
|
|
153
|
+
* issue a new request. A network or timeout failure after the server has
|
|
154
|
+
* processed the request may still have created an account, and the
|
|
155
|
+
* application key from a lost response is not recoverable from B2. Callers
|
|
156
|
+
* should reconcile account state out of band, such as through Partner
|
|
157
|
+
* account listing, before re-issuing a request for the same email address.
|
|
158
|
+
*
|
|
159
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`. The authorize response currently exposes the shared Partner endpoint base as `groupsApiUrl`.
|
|
160
|
+
* @param authToken - The Partner API authorization token.
|
|
161
|
+
* @param request - Email, term, storage, and optional region for the account to create.
|
|
162
|
+
* @param options - Optional abort and per-request retry settings.
|
|
163
|
+
*
|
|
164
|
+
* @returns The created reserve-trial account result.
|
|
165
|
+
*
|
|
166
|
+
* @experimental Partner API surface; shape may change as the Partner API docs evolve.
|
|
167
|
+
*/
|
|
168
|
+
reserveTrialCreateAccount(groupsApiUrl: string, authToken: string, request: ReserveTrialCreateAccountRequest, options?: PartnerRawRequestOptions): Promise<ReserveTrialCreateAccountResponse>;
|
|
169
|
+
/**
|
|
170
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-list-groups | b2_list_groups}.
|
|
171
|
+
*
|
|
172
|
+
* Uses the documented canonical GET form. The wire response is a single JSON
|
|
173
|
+
* object that surfaces `nextGroupId` for cursor-based pagination.
|
|
174
|
+
*
|
|
175
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
176
|
+
* @param authToken - The Partner API authorization token.
|
|
177
|
+
* @param request - The group listing query parameters.
|
|
178
|
+
* @param options - Optional abort and per-request retry settings.
|
|
179
|
+
*
|
|
180
|
+
* @returns The groups page object.
|
|
181
|
+
*/
|
|
182
|
+
listGroups(groupsApiUrl: string, authToken: string, request: ListGroupsRequest, options?: PartnerRawRequestOptions): Promise<ListGroupsResponse>;
|
|
183
|
+
/**
|
|
184
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-list-group-members | b2_list_group_members}.
|
|
185
|
+
*
|
|
186
|
+
* Uses the documented canonical GET form. The wire response is a JSON array
|
|
187
|
+
* whose result objects surface `nextEmail` for cursor-based pagination.
|
|
188
|
+
*
|
|
189
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
190
|
+
* @param authToken - The Partner API authorization token.
|
|
191
|
+
* @param request - The member listing query parameters.
|
|
192
|
+
* @param options - Optional abort and per-request retry settings.
|
|
193
|
+
*
|
|
194
|
+
* @returns The group-member page result array.
|
|
195
|
+
*/
|
|
196
|
+
listGroupMembers(groupsApiUrl: string, authToken: string, request: ListGroupMembersRequest, options?: PartnerRawRequestOptions): Promise<ListGroupMembersResponse>;
|
|
197
|
+
/**
|
|
198
|
+
* Sends a JSON GET request to the specified Partner API endpoint.
|
|
199
|
+
* @param groupsApiUrl - The Partner API base URL.
|
|
200
|
+
* @param authToken - The Partner API authorization token.
|
|
201
|
+
* @param endpoint - The Partner API endpoint name.
|
|
202
|
+
* @param query - The query-string parameters.
|
|
203
|
+
* @param options - Optional abort and per-request retry settings.
|
|
204
|
+
*
|
|
205
|
+
* @returns The parsed JSON response.
|
|
206
|
+
*/
|
|
207
|
+
private getJson;
|
|
208
|
+
/**
|
|
209
|
+
* Sends a non-retrying JSON mutation POST request to the specified Partner API endpoint.
|
|
210
|
+
* @param groupsApiUrl - The Partner API base URL.
|
|
211
|
+
* @param authToken - The Partner API authorization token.
|
|
212
|
+
* @param endpoint - The Partner API endpoint name.
|
|
213
|
+
* @param body - The JSON request body.
|
|
214
|
+
* @param options - Optional abort and per-request retry settings.
|
|
215
|
+
*
|
|
216
|
+
* @returns The parsed JSON response.
|
|
217
|
+
*/
|
|
218
|
+
private postNonRetryingMutationJson;
|
|
219
|
+
}
|
|
220
|
+
//# sourceMappingURL=raw.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"raw.d.ts","sourceRoot":"","sources":["../../src/partner/raw.js"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAEL,KAAK,aAAa,EAEnB,MAAM,sBAAsB,CAAA;AAI7B,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,wBAAwB,EACxB,iBAAiB,EACjB,kBAAkB,EAElB,wBAAwB,EAGxB,gCAAgC,EAChC,iCAAiC,EAClC,MAAM,qBAAqB,CAAA;AAiC5B,iEAAiE;AACjE,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;IACjC;;;;;;;;OAQG;IACH,QAAQ,CAAC,iCAAiC,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9D;;;OAGG;IACH,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAA;CAC7C;AAED,sDAAsD;AACtD,MAAM,WAAW,wBAAwB;IACvC,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CACvC;AAmID;;;;;;;;;;GAUG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,MAAM,GACf,SAAS,MAAM,EAAE,CASnB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yCAAyC,CACvD,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,MAAM,EAChB,yBAAyB,EAAE,OAAO,GACjC,SAAS,MAAM,EAAE,CAenB;AAyDD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAS;IACnD,OAAO,CAAC,0BAA0B,CAAmB;IAErD;;;;OAIG;gBACS,OAAO,EAAE,uBAAuB;IAM5C;;;;;;OAMG;IACH,6BAA6B,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAIhE;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,QAAQ,SAA4B,EACpC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAuBpC;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gCAAgC,EACzC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,iCAAiC,CAAC;IAW7C;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAe9B;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;;;;;;OASG;YACW,OAAO;IAwBrB;;;;;;;;;OASG;YACW,2BAA2B;CA2B1C"}
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { RetryOptions } from '../http/retry.js';
|
|
2
|
+
import { HttpTransport } from '../http/transport.js';
|
|
3
|
+
import { CreateGroupMemberRequest, CreateGroupMemberResponse, EjectGroupMemberRequest, EjectGroupMemberResponse, ListGroupMembersRequest, ListGroupMembersResponse, ListGroupsRequest, ListGroupsResponse, PartnerAuthorizeResponse, ReserveTrialCreateAccountRequest, ReserveTrialCreateAccountResponse } from '../types/partner.js';
|
|
4
|
+
/** Configuration for constructing a {@link PartnerRawClient}. */
|
|
5
|
+
export interface PartnerRawClientOptions {
|
|
6
|
+
/**
|
|
7
|
+
* The HTTP transport used to send requests.
|
|
8
|
+
*
|
|
9
|
+
* Partner endpoint calls validate URLs against suffixes recorded by
|
|
10
|
+
* `authorizePartner()`. A rehydrated client that skips authorization must use
|
|
11
|
+
* `authorizedPartnerEndpointSuffixes` or a {@link UrlGuardedTransport} with a
|
|
12
|
+
* locked `urlGuard`. Because Partner authorize responses redact
|
|
13
|
+
* `authorizationToken` under `JSON.stringify`, durable caches should persist
|
|
14
|
+
* `partnerAuthorizeResponseForPersistence(auth)` only to encrypted or
|
|
15
|
+
* otherwise credential-grade storage, or use another secure token-preserving
|
|
16
|
+
* representation.
|
|
17
|
+
*/
|
|
18
|
+
readonly transport: HttpTransport;
|
|
19
|
+
/**
|
|
20
|
+
* Validated Partner endpoint host suffixes restored from cached
|
|
21
|
+
* authorization. Facades normally manage this after authorization; direct raw
|
|
22
|
+
* clients can pass suffixes derived from trusted Partner authorization when
|
|
23
|
+
* rehydrating an auth cache. Do not derive this cache with
|
|
24
|
+
* `JSON.stringify(authorizePartner())`, which intentionally stores a redacted
|
|
25
|
+
* token placeholder instead of a usable Partner token. Rehydrating that
|
|
26
|
+
* placeholder fails fast.
|
|
27
|
+
*/
|
|
28
|
+
readonly authorizedPartnerEndpointSuffixes?: readonly string[];
|
|
29
|
+
/**
|
|
30
|
+
* Allow direct custom authorize realms for tests or private proxies.
|
|
31
|
+
* Leave disabled unless the configured host is trusted with the Master Application Key.
|
|
32
|
+
*/
|
|
33
|
+
readonly allowCustomAuthorizeRealm?: boolean;
|
|
34
|
+
}
|
|
35
|
+
/** Optional controls for raw Partner API requests. */
|
|
36
|
+
export interface PartnerRawRequestOptions {
|
|
37
|
+
/** Abort signal for cancelling the request. */
|
|
38
|
+
readonly signal?: AbortSignal;
|
|
39
|
+
/** Per-request retry override. */
|
|
40
|
+
readonly retry?: Partial<RetryOptions>;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Derives the Partner authorize and endpoint host suffixes that may receive
|
|
44
|
+
* Partner tokens after a trusted authorize response has been validated.
|
|
45
|
+
*
|
|
46
|
+
* @param auth - Normalized Partner authorize response.
|
|
47
|
+
* @param realmUrl - Realm URL used for Partner authorization.
|
|
48
|
+
*
|
|
49
|
+
* @returns Sorted list of unique host suffixes to allow.
|
|
50
|
+
*
|
|
51
|
+
* @internal
|
|
52
|
+
*/
|
|
53
|
+
export declare function derivePartnerAllowedSuffixes(auth: PartnerAuthorizeResponse, realmUrl: string): readonly string[];
|
|
54
|
+
/**
|
|
55
|
+
* Validates cached Partner authorize endpoint URLs with the same realm policy
|
|
56
|
+
* applied to fresh `authorizePartner()` responses and returns guard suffixes.
|
|
57
|
+
*
|
|
58
|
+
* @param auth - Cached Partner authorize response to validate.
|
|
59
|
+
* @param realmUrl - Realm URL used for Partner authorization.
|
|
60
|
+
* @param allowCustomAuthorizeRealm - Whether custom authorize realms are trusted.
|
|
61
|
+
*
|
|
62
|
+
* @returns Sorted list of host suffixes derived from the validated auth state.
|
|
63
|
+
*
|
|
64
|
+
* @throws B2PartnerAuthorizationError if the cached auth endpoints are unsafe.
|
|
65
|
+
*
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
export declare function validatePartnerAuthorizeResponseEndpoints(auth: PartnerAuthorizeResponse, realmUrl: string, allowCustomAuthorizeRealm: boolean): readonly string[];
|
|
69
|
+
/**
|
|
70
|
+
* Low-level client for Partner API authorization and endpoint bindings.
|
|
71
|
+
*/
|
|
72
|
+
export declare class PartnerRawClient {
|
|
73
|
+
/** @internal */
|
|
74
|
+
private readonly transport;
|
|
75
|
+
private readonly allowCustomAuthorizeRealm;
|
|
76
|
+
private authorizedEndpointSuffixes;
|
|
77
|
+
/**
|
|
78
|
+
* Creates a new PartnerRawClient with the given transport.
|
|
79
|
+
*
|
|
80
|
+
* @param options - The constructor configuration.
|
|
81
|
+
*/
|
|
82
|
+
constructor(options: PartnerRawClientOptions);
|
|
83
|
+
/**
|
|
84
|
+
* Replaces the validated Partner endpoint host suffixes.
|
|
85
|
+
*
|
|
86
|
+
* @param suffixes - Host suffixes derived from Partner authorization.
|
|
87
|
+
*
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
setAuthorizedEndpointSuffixes(suffixes: readonly string[]): void;
|
|
91
|
+
/**
|
|
92
|
+
* Calls `b2_authorize_account` with Master Application Key credentials and
|
|
93
|
+
* normalizes the Partner/Backup suites into a Partner-specific auth shape.
|
|
94
|
+
*
|
|
95
|
+
* The Partner API documentation currently shows the v3 authorize path, so
|
|
96
|
+
* this method intentionally uses `/b2api/v3/b2_authorize_account` while the
|
|
97
|
+
* storage raw client keeps using v4.
|
|
98
|
+
*
|
|
99
|
+
* @param masterKeyId - The Master Application Key ID for authentication.
|
|
100
|
+
* @param masterKey - The Master Application Key secret.
|
|
101
|
+
* @param realmUrl - The B2 realm URL to authenticate against.
|
|
102
|
+
* @param options - Optional abort and per-request retry settings.
|
|
103
|
+
*
|
|
104
|
+
* @returns The normalized Partner authorization response.
|
|
105
|
+
*
|
|
106
|
+
* @throws B2RealmConfigurationError if the realm URL is unsafe for Master Application Key credentials.
|
|
107
|
+
* @throws B2PartnerAuthorizationError if the response omits or returns unsafe Partner endpoint data.
|
|
108
|
+
*/
|
|
109
|
+
authorizePartner(masterKeyId: string, masterKey: string, realmUrl?: string, options?: PartnerRawRequestOptions): Promise<PartnerAuthorizeResponse>;
|
|
110
|
+
/**
|
|
111
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-create-group-member | b2_create_group_member}.
|
|
112
|
+
*
|
|
113
|
+
* The Partner API creates a new Backblaze account for an email address that
|
|
114
|
+
* is not already a Backblaze account and adds that account to the managed
|
|
115
|
+
* group. The wire response is a single JSON object.
|
|
116
|
+
*
|
|
117
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
118
|
+
* @param authToken - The Partner API authorization token.
|
|
119
|
+
* @param request - The group-member creation request body.
|
|
120
|
+
* @param options - Optional abort and per-request retry settings.
|
|
121
|
+
*
|
|
122
|
+
* @returns The created member result, including the member application key.
|
|
123
|
+
*/
|
|
124
|
+
createGroupMember(groupsApiUrl: string, authToken: string, request: CreateGroupMemberRequest, options?: PartnerRawRequestOptions): Promise<CreateGroupMemberResponse>;
|
|
125
|
+
/**
|
|
126
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-eject-group-member | b2_eject_group_member}.
|
|
127
|
+
*
|
|
128
|
+
* Ejection removes the member account from the group but does not delete the
|
|
129
|
+
* Backblaze account. The wire response is a single JSON object.
|
|
130
|
+
*
|
|
131
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
132
|
+
* @param authToken - The Partner API authorization token.
|
|
133
|
+
* @param request - The group-member ejection request body.
|
|
134
|
+
* @param options - Optional abort and per-request retry settings.
|
|
135
|
+
*
|
|
136
|
+
* @returns The ejected member object.
|
|
137
|
+
*/
|
|
138
|
+
ejectGroupMember(groupsApiUrl: string, authToken: string, request: EjectGroupMemberRequest, options?: PartnerRawRequestOptions): Promise<EjectGroupMemberResponse>;
|
|
139
|
+
/**
|
|
140
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-reserve-trial-create-account | b2_reserve_trial_create_account}.
|
|
141
|
+
*
|
|
142
|
+
* The Partner API creates one new Backblaze B2 account and starts a B2
|
|
143
|
+
* Reserve trial for it. The wire request and success response are single
|
|
144
|
+
* JSON objects.
|
|
145
|
+
*
|
|
146
|
+
* Each email address must not already be a Backblaze account. `term` is the
|
|
147
|
+
* trial duration in days, documented as 7 through 30 inclusive. `storage` is
|
|
148
|
+
* the requested storage in TB, documented as 1 through 50 inclusive.
|
|
149
|
+
*
|
|
150
|
+
* This operation is non-idempotent and creates billable accounts. Automatic
|
|
151
|
+
* retries and expired-token reauthorization are disabled; long-lived
|
|
152
|
+
* callers must catch auth expiry, reauthorize, and then decide whether to
|
|
153
|
+
* issue a new request. A network or timeout failure after the server has
|
|
154
|
+
* processed the request may still have created an account, and the
|
|
155
|
+
* application key from a lost response is not recoverable from B2. Callers
|
|
156
|
+
* should reconcile account state out of band, such as through Partner
|
|
157
|
+
* account listing, before re-issuing a request for the same email address.
|
|
158
|
+
*
|
|
159
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`. The authorize response currently exposes the shared Partner endpoint base as `groupsApiUrl`.
|
|
160
|
+
* @param authToken - The Partner API authorization token.
|
|
161
|
+
* @param request - Email, term, storage, and optional region for the account to create.
|
|
162
|
+
* @param options - Optional abort and per-request retry settings.
|
|
163
|
+
*
|
|
164
|
+
* @returns The created reserve-trial account result.
|
|
165
|
+
*
|
|
166
|
+
* @experimental Partner API surface; shape may change as the Partner API docs evolve.
|
|
167
|
+
*/
|
|
168
|
+
reserveTrialCreateAccount(groupsApiUrl: string, authToken: string, request: ReserveTrialCreateAccountRequest, options?: PartnerRawRequestOptions): Promise<ReserveTrialCreateAccountResponse>;
|
|
169
|
+
/**
|
|
170
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-list-groups | b2_list_groups}.
|
|
171
|
+
*
|
|
172
|
+
* Uses the documented canonical GET form. The wire response is a single JSON
|
|
173
|
+
* object that surfaces `nextGroupId` for cursor-based pagination.
|
|
174
|
+
*
|
|
175
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
176
|
+
* @param authToken - The Partner API authorization token.
|
|
177
|
+
* @param request - The group listing query parameters.
|
|
178
|
+
* @param options - Optional abort and per-request retry settings.
|
|
179
|
+
*
|
|
180
|
+
* @returns The groups page object.
|
|
181
|
+
*/
|
|
182
|
+
listGroups(groupsApiUrl: string, authToken: string, request: ListGroupsRequest, options?: PartnerRawRequestOptions): Promise<ListGroupsResponse>;
|
|
183
|
+
/**
|
|
184
|
+
* Calls {@link https://www.backblaze.com/apidocs/b2-list-group-members | b2_list_group_members}.
|
|
185
|
+
*
|
|
186
|
+
* Uses the documented canonical GET form. The wire response is a JSON array
|
|
187
|
+
* whose result objects surface `nextEmail` for cursor-based pagination.
|
|
188
|
+
*
|
|
189
|
+
* @param groupsApiUrl - The Partner API base URL from `authorizePartner`.
|
|
190
|
+
* @param authToken - The Partner API authorization token.
|
|
191
|
+
* @param request - The member listing query parameters.
|
|
192
|
+
* @param options - Optional abort and per-request retry settings.
|
|
193
|
+
*
|
|
194
|
+
* @returns The group-member page result array.
|
|
195
|
+
*/
|
|
196
|
+
listGroupMembers(groupsApiUrl: string, authToken: string, request: ListGroupMembersRequest, options?: PartnerRawRequestOptions): Promise<ListGroupMembersResponse>;
|
|
197
|
+
/**
|
|
198
|
+
* Sends a JSON GET request to the specified Partner API endpoint.
|
|
199
|
+
* @param groupsApiUrl - The Partner API base URL.
|
|
200
|
+
* @param authToken - The Partner API authorization token.
|
|
201
|
+
* @param endpoint - The Partner API endpoint name.
|
|
202
|
+
* @param query - The query-string parameters.
|
|
203
|
+
* @param options - Optional abort and per-request retry settings.
|
|
204
|
+
*
|
|
205
|
+
* @returns The parsed JSON response.
|
|
206
|
+
*/
|
|
207
|
+
private getJson;
|
|
208
|
+
/**
|
|
209
|
+
* Sends a non-retrying JSON mutation POST request to the specified Partner API endpoint.
|
|
210
|
+
* @param groupsApiUrl - The Partner API base URL.
|
|
211
|
+
* @param authToken - The Partner API authorization token.
|
|
212
|
+
* @param endpoint - The Partner API endpoint name.
|
|
213
|
+
* @param body - The JSON request body.
|
|
214
|
+
* @param options - Optional abort and per-request retry settings.
|
|
215
|
+
*
|
|
216
|
+
* @returns The parsed JSON response.
|
|
217
|
+
*/
|
|
218
|
+
private postNonRetryingMutationJson;
|
|
219
|
+
}
|
|
220
|
+
//# sourceMappingURL=raw.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"raw.d.ts","sourceRoot":"","sources":["../../src/partner/raw.js"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,EAEL,KAAK,aAAa,EAEnB,MAAM,sBAAsB,CAAA;AAI7B,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,wBAAwB,EACxB,uBAAuB,EACvB,wBAAwB,EACxB,iBAAiB,EACjB,kBAAkB,EAElB,wBAAwB,EAGxB,gCAAgC,EAChC,iCAAiC,EAClC,MAAM,qBAAqB,CAAA;AAiC5B,iEAAiE;AACjE,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;IACjC;;;;;;;;OAQG;IACH,QAAQ,CAAC,iCAAiC,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9D;;;OAGG;IACH,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAA;CAC7C;AAED,sDAAsD;AACtD,MAAM,WAAW,wBAAwB;IACvC,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CACvC;AAmID;;;;;;;;;;GAUG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,MAAM,GACf,SAAS,MAAM,EAAE,CASnB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,yCAAyC,CACvD,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,EAAE,MAAM,EAChB,yBAAyB,EAAE,OAAO,GACjC,SAAS,MAAM,EAAE,CAenB;AAyDD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAAS;IACnD,OAAO,CAAC,0BAA0B,CAAmB;IAErD;;;;OAIG;gBACS,OAAO,EAAE,uBAAuB;IAM5C;;;;;;OAMG;IACH,6BAA6B,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAIhE;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,QAAQ,SAA4B,EACpC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAuBpC;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,yBAAyB,CAAC;IAgBrC;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,yBAAyB,CAC7B,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gCAAgC,EACzC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,iCAAiC,CAAC;IAW7C;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAe9B;;;;;;;;;;;;OAYG;IACG,gBAAgB,CACpB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,wBAAwB,CAAC;IAepC;;;;;;;;;OASG;YACW,OAAO;IAwBrB;;;;;;;;;OASG;YACW,2BAA2B;CA2B1C"}
|