@ardrive/turbo-sdk 1.0.1 → 1.0.2
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/README.md +45 -3
- package/bundles/web.bundle.min.js +3 -3
- package/lib/cjs/common/upload.js +3 -3
- package/lib/cjs/version.js +1 -1
- package/lib/esm/common/upload.js +2 -2
- package/lib/esm/version.js +1 -1
- package/lib/types/common/upload.d.ts +1 -1
- package/lib/types/common/upload.d.ts.map +1 -1
- package/lib/types/version.d.ts +1 -1
- package/lib/types/version.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
@@ -19,7 +19,16 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interac
|
|
19
19
|
- [TurboUnauthenticatedClient](#turbounauthenticatedclient)
|
20
20
|
- [TurboAuthenticatedClient](#turboauthenticatedclient)
|
21
21
|
- [Examples](./examples)
|
22
|
-
- [
|
22
|
+
- [CJS](./examples/cjs/index.ts)
|
23
|
+
- [ESM](./examples/esm/index.ts)
|
24
|
+
- [Web](./examples/web/index.html)
|
25
|
+
- [Developers](#developers)
|
26
|
+
- [Requirements](#requirements)
|
27
|
+
- [Setup & Build](#setup--build)
|
28
|
+
- [Testing](#testing)
|
29
|
+
- [Linting and Formatting](#linting--formatting)
|
30
|
+
- [Architecture](#architecture)
|
31
|
+
- [Contributing](./CONTRIBUTING.md)
|
23
32
|
|
24
33
|
## Installation
|
25
34
|
|
@@ -334,11 +343,44 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
|
|
334
343
|
});
|
335
344
|
```
|
336
345
|
|
337
|
-
##
|
346
|
+
## Developers
|
338
347
|
|
339
|
-
|
348
|
+
### Requirements
|
349
|
+
|
350
|
+
- `nvm`
|
351
|
+
- `node` (>= 18)
|
352
|
+
- `yarn`
|
353
|
+
|
354
|
+
### Setup & Build
|
355
|
+
|
356
|
+
- `yarn install` - installs dependencies
|
357
|
+
- `yarn build` - builds web/node/bundled outputs
|
358
|
+
|
359
|
+
### Testing
|
360
|
+
|
361
|
+
- `yarn test` - runs integration tests
|
362
|
+
- `yarn example:web` - opens up the example web page
|
363
|
+
- `yarn example:cjs` - runs example CJS node script
|
364
|
+
- `yarn example:mjs` - runs example ESM node script
|
365
|
+
|
366
|
+
### Linting & Formatting
|
367
|
+
|
368
|
+
- `yarn lint:check` - checks for linting errors
|
369
|
+
- `yarn lint:fix` - fixes linting errors
|
370
|
+
- `yarn format:check` - checks for formatting errors
|
371
|
+
- `yarn format:fix` - fixes formatting errors
|
372
|
+
|
373
|
+
### Architecture
|
374
|
+
|
375
|
+
- Code to interfaces.
|
376
|
+
- Prefer type safety over runtime safety.
|
377
|
+
- Prefer composition over inheritance.
|
378
|
+
- Prefer integration tests over unit tests.
|
379
|
+
|
380
|
+
For more information on how to contribute, please see [CONTRIBUTING.md].
|
340
381
|
|
341
382
|
[package.json]: ./package.json
|
342
383
|
[examples]: ./examples
|
343
384
|
[TurboAuthenticatedClient]: #turboauthenticatedclient
|
344
385
|
[AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
386
|
+
[CONTRIBUTING.md]: ./CONTRIBUTING.md
|
@@ -47309,7 +47309,7 @@ axiosRetry.isRetryableError = isRetryableError;
|
|
47309
47309
|
|
47310
47310
|
// src/version.ts
|
47311
47311
|
init_shim();
|
47312
|
-
var version = "1.0.1
|
47312
|
+
var version = "1.0.1";
|
47313
47313
|
|
47314
47314
|
// src/utils/axiosClient.ts
|
47315
47315
|
var defaultRequestHeaders = {
|
@@ -47521,8 +47521,8 @@ init_shim();
|
|
47521
47521
|
|
47522
47522
|
// src/common/upload.ts
|
47523
47523
|
init_shim();
|
47524
|
-
var defaultUploadServiceURL = "https://upload.ardrive.io";
|
47525
47524
|
var developmentUploadServiceURL = "https://upload.ardrive.dev";
|
47525
|
+
var defaultUploadServiceURL = "https://upload.ardrive.io";
|
47526
47526
|
var TurboUnauthenticatedUploadService = class {
|
47527
47527
|
constructor({
|
47528
47528
|
url = defaultUploadServiceURL,
|
@@ -47552,7 +47552,7 @@ var TurboUnauthenticatedUploadService = class {
|
|
47552
47552
|
};
|
47553
47553
|
var TurboAuthenticatedUploadService = class extends TurboUnauthenticatedUploadService {
|
47554
47554
|
constructor({
|
47555
|
-
url =
|
47555
|
+
url = defaultUploadServiceURL,
|
47556
47556
|
retryConfig,
|
47557
47557
|
signer
|
47558
47558
|
}) {
|
package/lib/cjs/common/upload.js
CHANGED
@@ -1,9 +1,9 @@
|
|
1
1
|
"use strict";
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
3
|
-
exports.TurboAuthenticatedUploadService = exports.TurboUnauthenticatedUploadService = exports.
|
3
|
+
exports.TurboAuthenticatedUploadService = exports.TurboUnauthenticatedUploadService = exports.defaultUploadServiceURL = exports.developmentUploadServiceURL = void 0;
|
4
4
|
const http_js_1 = require("./http.js");
|
5
|
-
exports.defaultUploadServiceURL = 'https://upload.ardrive.io';
|
6
5
|
exports.developmentUploadServiceURL = 'https://upload.ardrive.dev';
|
6
|
+
exports.defaultUploadServiceURL = 'https://upload.ardrive.io';
|
7
7
|
class TurboUnauthenticatedUploadService {
|
8
8
|
constructor({ url = exports.defaultUploadServiceURL, retryConfig, }) {
|
9
9
|
this.httpService = new http_js_1.TurboHTTPService({
|
@@ -28,7 +28,7 @@ class TurboUnauthenticatedUploadService {
|
|
28
28
|
exports.TurboUnauthenticatedUploadService = TurboUnauthenticatedUploadService;
|
29
29
|
// NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
|
30
30
|
class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService {
|
31
|
-
constructor({ url =
|
31
|
+
constructor({ url = exports.defaultUploadServiceURL, retryConfig, signer, }) {
|
32
32
|
super({ url, retryConfig });
|
33
33
|
this.signer = signer;
|
34
34
|
}
|
package/lib/cjs/version.js
CHANGED
package/lib/esm/common/upload.js
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
import { TurboHTTPService } from './http.js';
|
2
|
-
export const defaultUploadServiceURL = 'https://upload.ardrive.io';
|
3
2
|
export const developmentUploadServiceURL = 'https://upload.ardrive.dev';
|
3
|
+
export const defaultUploadServiceURL = 'https://upload.ardrive.io';
|
4
4
|
export class TurboUnauthenticatedUploadService {
|
5
5
|
constructor({ url = defaultUploadServiceURL, retryConfig, }) {
|
6
6
|
this.httpService = new TurboHTTPService({
|
@@ -24,7 +24,7 @@ export class TurboUnauthenticatedUploadService {
|
|
24
24
|
}
|
25
25
|
// NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
|
26
26
|
export class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService {
|
27
|
-
constructor({ url =
|
27
|
+
constructor({ url = defaultUploadServiceURL, retryConfig, signer, }) {
|
28
28
|
super({ url, retryConfig });
|
29
29
|
this.signer = signer;
|
30
30
|
}
|
package/lib/esm/version.js
CHANGED
@@ -16,8 +16,8 @@
|
|
16
16
|
*/
|
17
17
|
import { TurboAbortSignal, TurboAuthenticatedUploadServiceConfiguration, TurboAuthenticatedUploadServiceInterface, TurboFileFactory, TurboSignedDataItemFactory, TurboUnauthenticatedUploadServiceConfiguration, TurboUnauthenticatedUploadServiceInterface, TurboUploadDataItemResponse, TurboWalletSigner } from '../types.js';
|
18
18
|
import { TurboHTTPService } from './http.js';
|
19
|
-
export declare const defaultUploadServiceURL = "https://upload.ardrive.io";
|
20
19
|
export declare const developmentUploadServiceURL = "https://upload.ardrive.dev";
|
20
|
+
export declare const defaultUploadServiceURL = "https://upload.ardrive.io";
|
21
21
|
export declare class TurboUnauthenticatedUploadService implements TurboUnauthenticatedUploadServiceInterface {
|
22
22
|
protected httpService: TurboHTTPService;
|
23
23
|
constructor({ url, retryConfig, }: TurboUnauthenticatedUploadServiceConfiguration);
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../../src/common/upload.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EACL,gBAAgB,EAChB,4CAA4C,EAC5C,wCAAwC,EACxC,gBAAgB,EAChB,0BAA0B,EAC1B,8CAA8C,EAC9C,0CAA0C,EAC1C,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,eAAO,MAAM,
|
1
|
+
{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../../src/common/upload.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EACL,gBAAgB,EAChB,4CAA4C,EAC5C,wCAAwC,EACxC,gBAAgB,EAChB,0BAA0B,EAC1B,8CAA8C,EAC9C,0CAA0C,EAC1C,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,eAAO,MAAM,2BAA2B,+BAA+B,CAAC;AACxE,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AAEnE,qBAAa,iCACX,YAAW,0CAA0C;IAErD,SAAS,CAAC,WAAW,EAAE,gBAAgB,CAAC;gBAE5B,EACV,GAA6B,EAC7B,WAAW,GACZ,EAAE,8CAA8C;IAO3C,oBAAoB,CAAC,EACzB,qBAAqB,EACrB,mBAAmB,EACnB,MAAM,GACP,EAAE,0BAA0B,GAC3B,gBAAgB,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAa1D;AAGD,qBAAa,+BACX,SAAQ,iCACR,YAAW,wCAAwC;IAEnD,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;gBAExB,EACV,GAA6B,EAC7B,WAAW,EACX,MAAM,GACP,EAAE,4CAA4C;IAKzC,UAAU,CAAC,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,GACP,EAAE,gBAAgB,GACjB,gBAAgB,GAAG,OAAO,CAAC,2BAA2B,CAAC;CAmB1D"}
|
package/lib/types/version.d.ts
CHANGED
@@ -14,5 +14,5 @@
|
|
14
14
|
* You should have received a copy of the GNU Affero General Public License
|
15
15
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
16
16
|
*/
|
17
|
-
export declare const version = "1.0.1
|
17
|
+
export declare const version = "1.0.1";
|
18
18
|
//# sourceMappingURL=version.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,eAAO,MAAM,OAAO,
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,eAAO,MAAM,OAAO,UAAU,CAAC"}
|