@ardrive/turbo-sdk 1.0.1 → 1.0.2

package/README.md

@@ -19,7 +19,16 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionality for interac
   - [TurboUnauthenticatedClient](#turbounauthenticatedclient)
   - [TurboAuthenticatedClient](#turboauthenticatedclient)
 - [Examples](./examples)
-- [Contributions](#contributions)
+  - [CJS](./examples/cjs/index.ts)
+  - [ESM](./examples/esm/index.ts)
+  - [Web](./examples/web/index.html)
+- [Developers](#developers)
+  - [Requirements](#requirements)
+  - [Setup & Build](#setup--build)
+  - [Testing](#testing)
+  - [Linting and Formatting](#linting--formatting)
+  - [Architecture](#architecture)
+- [Contributing](./CONTRIBUTING.md)
 
 ## Installation
 
@@ -334,11 +343,44 @@ Types are exported from `./lib/types/[node/web]/index.d.ts` and should be automa
   });
   ```
 
-## Contributions
+## Developers
 
-If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are both welcome and encouraged.
+### Requirements
+
+- `nvm`
+- `node` (>= 18)
+- `yarn`
+
+### Setup & Build
+
+- `yarn install` - installs dependencies
+- `yarn build` - builds web/node/bundled outputs
+
+### Testing
+
+- `yarn test` - runs integration tests
+- `yarn example:web` - opens up the example web page
+- `yarn example:cjs` - runs example CJS node script
+- `yarn example:mjs` - runs example ESM node script
+
+### Linting & Formatting
+
+- `yarn lint:check` - checks for linting errors
+- `yarn lint:fix` - fixes linting errors
+- `yarn format:check` - checks for formatting errors
+- `yarn format:fix` - fixes formatting errors
+
+### Architecture
+
+- Code to interfaces.
+- Prefer type safety over runtime safety.
+- Prefer composition over inheritance.
+- Prefer integration tests over unit tests.
+
+For more information on how to contribute, please see [CONTRIBUTING.md].
 
 [package.json]: ./package.json
 [examples]: ./examples
 [TurboAuthenticatedClient]: #turboauthenticatedclient
 [AbortSignal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[CONTRIBUTING.md]: ./CONTRIBUTING.md

package/bundles/web.bundle.min.js

@@ -47309,7 +47309,7 @@ axiosRetry.isRetryableError = isRetryableError;
 
 // src/version.ts
 init_shim();
-var version = "1.0.1-alpha.3";
+var version = "1.0.1";
 
 // src/utils/axiosClient.ts
 var defaultRequestHeaders = {
@@ -47521,8 +47521,8 @@ init_shim();
 
 // src/common/upload.ts
 init_shim();
-var defaultUploadServiceURL = "https://upload.ardrive.io";
 var developmentUploadServiceURL = "https://upload.ardrive.dev";
+var defaultUploadServiceURL = "https://upload.ardrive.io";
 var TurboUnauthenticatedUploadService = class {
   constructor({
     url = defaultUploadServiceURL,
@@ -47552,7 +47552,7 @@ var TurboUnauthenticatedUploadService = class {
 };
 var TurboAuthenticatedUploadService = class extends TurboUnauthenticatedUploadService {
   constructor({
-    url = "https://upload.ardrive.dev",
+    url = defaultUploadServiceURL,
     retryConfig,
     signer
   }) {

package/lib/cjs/common/upload.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TurboAuthenticatedUploadService = exports.TurboUnauthenticatedUploadService = exports.developmentUploadServiceURL = exports.defaultUploadServiceURL = void 0;
+exports.TurboAuthenticatedUploadService = exports.TurboUnauthenticatedUploadService = exports.defaultUploadServiceURL = exports.developmentUploadServiceURL = void 0;
 const http_js_1 = require("./http.js");
-exports.defaultUploadServiceURL = 'https://upload.ardrive.io';
 exports.developmentUploadServiceURL = 'https://upload.ardrive.dev';
+exports.defaultUploadServiceURL = 'https://upload.ardrive.io';
 class TurboUnauthenticatedUploadService {
     constructor({ url = exports.defaultUploadServiceURL, retryConfig, }) {
         this.httpService = new http_js_1.TurboHTTPService({
@@ -28,7 +28,7 @@ class TurboUnauthenticatedUploadService {
 exports.TurboUnauthenticatedUploadService = TurboUnauthenticatedUploadService;
 // NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
 class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService {
-    constructor({ url = 'https://upload.ardrive.dev', retryConfig, signer, }) {
+    constructor({ url = exports.defaultUploadServiceURL, retryConfig, signer, }) {
         super({ url, retryConfig });
         this.signer = signer;
     }

package/lib/cjs/version.js

@@ -18,4 +18,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '1.0.1';
+exports.version = '1.0.2';

package/lib/esm/common/upload.js

@@ -1,6 +1,6 @@
 import { TurboHTTPService } from './http.js';
-export const defaultUploadServiceURL = 'https://upload.ardrive.io';
 export const developmentUploadServiceURL = 'https://upload.ardrive.dev';
+export const defaultUploadServiceURL = 'https://upload.ardrive.io';
 export class TurboUnauthenticatedUploadService {
     constructor({ url = defaultUploadServiceURL, retryConfig, }) {
         this.httpService = new TurboHTTPService({
@@ -24,7 +24,7 @@ export class TurboUnauthenticatedUploadService {
 }
 // NOTE: to avoid redundancy, we use inheritance here - but generally prefer composition over inheritance
 export class TurboAuthenticatedUploadService extends TurboUnauthenticatedUploadService {
-    constructor({ url = 'https://upload.ardrive.dev', retryConfig, signer, }) {
+    constructor({ url = defaultUploadServiceURL, retryConfig, signer, }) {
         super({ url, retryConfig });
         this.signer = signer;
     }

package/lib/esm/version.js

@@ -15,4 +15,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.0.1';
+export const version = '1.0.2';

package/lib/types/common/upload.d.ts

@@ -16,8 +16,8 @@
  */
 import { TurboAbortSignal, TurboAuthenticatedUploadServiceConfiguration, TurboAuthenticatedUploadServiceInterface, TurboFileFactory, TurboSignedDataItemFactory, TurboUnauthenticatedUploadServiceConfiguration, TurboUnauthenticatedUploadServiceInterface, TurboUploadDataItemResponse, TurboWalletSigner } from '../types.js';
 import { TurboHTTPService } from './http.js';
-export declare const defaultUploadServiceURL = "https://upload.ardrive.io";
 export declare const developmentUploadServiceURL = "https://upload.ardrive.dev";
+export declare const defaultUploadServiceURL = "https://upload.ardrive.io";
 export declare class TurboUnauthenticatedUploadService implements TurboUnauthenticatedUploadServiceInterface {
     protected httpService: TurboHTTPService;
     constructor({ url, retryConfig, }: TurboUnauthenticatedUploadServiceConfiguration);

package/lib/types/common/upload.d.ts.map

@@ -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,uBAAuB,8BAA8B,CAAC;AACnE,eAAO,MAAM,2BAA2B,+BAA+B,CAAC;AAExE,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,GAAkC,EAClC,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"}
+{"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

@@ -14,5 +14,5 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-export declare const version = "1.0.1-alpha.3";
+export declare const version = "1.0.1";
 //# sourceMappingURL=version.d.ts.map

package/lib/types/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,eAAO,MAAM,OAAO,kBAAkB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ardrive/turbo-sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "./lib/cjs/node/index.js",
   "types": "./lib/types/node/index.d.ts",
   "module": "./lib/esm/node/index.js",