@stacks/network 6.17.0 → 7.0.0-beta.0

package/src/network.ts

@@ -1,215 +1,132 @@
-import { TransactionVersion, ChainID } from '@stacks/common';
-import { createFetchFn, FetchFn } from './fetch';
-
-export const HIRO_MAINNET_DEFAULT = 'https://api.mainnet.hiro.so';
-export const HIRO_TESTNET_DEFAULT = 'https://api.testnet.hiro.so';
-export const HIRO_MOCKNET_DEFAULT = 'http://localhost:3999';
+import {
+  ClientOpts,
+  DEVNET_URL,
+  FetchFn,
+  HIRO_MAINNET_URL,
+  HIRO_TESTNET_URL,
+  createFetchFn,
+} from '@stacks/common';
+import { AddressVersion, ChainId, PeerNetworkId, TransactionVersion } from './constants';
+import { ClientParam } from '@stacks/common';
+
+export type StacksNetwork = {
+  chainId: number;
+  transactionVersion: number; // todo: txVersion better?
+  peerNetworkId: number;
+  magicBytes: string;
+  bootAddress: string;
+  addressVersion: {
+    singleSig: number;
+    multiSig: number;
+  };
+  // todo: add check32 character bytes string
+  client: {
+    baseUrl: string; // URL is always required
+    fetch?: FetchFn; // fetch is optional and will be created by default in fetch helpers
+  };
+};
 
-/**
- * Used for constructing Network instances
- * @related {@link StacksNetwork}, {@link StacksMainnet}, {@link StacksTestnet}, {@link StacksDevnet}, {@link StacksMocknet}
- */
-export interface NetworkConfig {
-  /** The base API/node URL for the network fetch calls */
-  url: string;
-  /** An optional custom fetch function to override default behaviors */
-  fetchFn?: FetchFn;
+export interface NetworkParam {
+  network?: StacksNetworkName | StacksNetwork;
 }
 
+export type NetworkClientParam = NetworkParam & ClientParam;
+
+export const STACKS_MAINNET: StacksNetwork = {
+  chainId: ChainId.Mainnet,
+  transactionVersion: TransactionVersion.Mainnet,
+  peerNetworkId: PeerNetworkId.Mainnet,
+  magicBytes: 'X2', // todo: comment bytes version of magic bytes
+  bootAddress: 'SP000000000000000000002Q6VF78',
+  addressVersion: {
+    singleSig: AddressVersion.MainnetSingleSig,
+    multiSig: AddressVersion.MainnetMultiSig,
+  },
+  client: { baseUrl: HIRO_MAINNET_URL },
+};
+
+export const STACKS_TESTNET: StacksNetwork = {
+  chainId: ChainId.Testnet,
+  transactionVersion: TransactionVersion.Testnet,
+  peerNetworkId: PeerNetworkId.Testnet,
+  magicBytes: 'T2', // todo: comment bytes version of magic bytes
+  bootAddress: 'ST000000000000000000002AMW42H',
+  addressVersion: {
+    singleSig: AddressVersion.TestnetSingleSig,
+    multiSig: AddressVersion.TestnetMultiSig,
+  },
+  client: { baseUrl: HIRO_TESTNET_URL },
+};
+
+export const STACKS_DEVNET: StacksNetwork = {
+  ...STACKS_TESTNET, // todo: ensure deep copy
+  addressVersion: { ...STACKS_TESTNET.addressVersion }, // deep copy
+  magicBytes: 'id', // todo: comment bytes version of magic bytes
+  client: { baseUrl: DEVNET_URL },
+};
+
+export const STACKS_MOCKNET: StacksNetwork = {
+  ...STACKS_DEVNET,
+  addressVersion: { ...STACKS_DEVNET.addressVersion }, // deep copy
+  client: { ...STACKS_DEVNET.client }, // deep copy
+};
+
 /** @ignore internal */
 export const StacksNetworks = ['mainnet', 'testnet', 'devnet', 'mocknet'] as const;
 /** The enum-style names of different common Stacks networks */
 export type StacksNetworkName = (typeof StacksNetworks)[number];
 
 /**
- * The base class for Stacks networks. Typically used via its subclasses.
- * @related {@link StacksMainnet}, {@link StacksTestnet}, {@link StacksDevnet}, {@link StacksMocknet}
- */
-export class StacksNetwork {
-  version: TransactionVersion = TransactionVersion.Mainnet;
-  chainId: ChainID = ChainID.Mainnet;
-  bnsLookupUrl = 'https://api.mainnet.hiro.so';
-  broadcastEndpoint = '/v2/transactions';
-  transferFeeEstimateEndpoint = '/v2/fees/transfer';
-  transactionFeeEstimateEndpoint = '/v2/fees/transaction';
-  accountEndpoint = '/v2/accounts';
-  contractAbiEndpoint = '/v2/contracts/interface';
-  readOnlyFunctionCallEndpoint = '/v2/contracts/call-read';
-
-  readonly coreApiUrl: string;
-
-  fetchFn: FetchFn;
-
-  constructor(networkConfig: NetworkConfig) {
-    this.coreApiUrl = networkConfig.url;
-    this.fetchFn = networkConfig.fetchFn ?? createFetchFn();
-  }
-
-  /** A static network constructor from a network name */
-  static fromName = (networkName: StacksNetworkName): StacksNetwork => {
-    switch (networkName) {
-      case 'mainnet':
-        return new StacksMainnet();
-      case 'testnet':
-        return new StacksTestnet();
-      case 'devnet':
-        return new StacksDevnet();
-      case 'mocknet':
-        return new StacksMocknet();
-      default:
-        throw new Error(
-          `Invalid network name provided. Must be one of the following: ${StacksNetworks.join(
-            ', '
-          )}`
-        );
-    }
-  };
-
-  /** @ignore internal */
-  static fromNameOrNetwork = (network: StacksNetworkName | StacksNetwork) => {
-    if (typeof network !== 'string' && 'version' in network) {
-      return network;
-    }
-
-    return StacksNetwork.fromName(network);
-  };
-
-  /** Returns `true` if the network is configured to 'mainnet', based on the TransactionVersion */
-  isMainnet = () => this.version === TransactionVersion.Mainnet;
-  getBroadcastApiUrl = () => `${this.coreApiUrl}${this.broadcastEndpoint}`;
-  getTransferFeeEstimateApiUrl = () => `${this.coreApiUrl}${this.transferFeeEstimateEndpoint}`;
-  getTransactionFeeEstimateApiUrl = () =>
-    `${this.coreApiUrl}${this.transactionFeeEstimateEndpoint}`;
-  getAccountApiUrl = (address: string) =>
-    `${this.coreApiUrl}${this.accountEndpoint}/${address}?proof=0`;
-  getAccountExtendedBalancesApiUrl = (address: string) =>
-    `${this.coreApiUrl}/extended/v1/address/${address}/balances`;
-  getAbiApiUrl = (address: string, contract: string) =>
-    `${this.coreApiUrl}${this.contractAbiEndpoint}/${address}/${contract}`;
-  getReadOnlyFunctionCallApiUrl = (
-    contractAddress: string,
-    contractName: string,
-    functionName: string
-  ) =>
-    `${this.coreApiUrl}${
-      this.readOnlyFunctionCallEndpoint
-    }/${contractAddress}/${contractName}/${encodeURIComponent(functionName)}`;
-  getInfoUrl = () => `${this.coreApiUrl}/v2/info`;
-  getBlockTimeInfoUrl = () => `${this.coreApiUrl}/extended/v1/info/network_block_times`;
-  getPoxInfoUrl = () => `${this.coreApiUrl}/v2/pox`;
-  getRewardsUrl = (address: string, options?: any) => {
-    let url = `${this.coreApiUrl}/extended/v1/burnchain/rewards/${address}`;
-    if (options) {
-      url = `${url}?limit=${options.limit}&offset=${options.offset}`;
-    }
-    return url;
-  };
-  getRewardsTotalUrl = (address: string) =>
-    `${this.coreApiUrl}/extended/v1/burnchain/rewards/${address}/total`;
-  getRewardHoldersUrl = (address: string, options?: any) => {
-    let url = `${this.coreApiUrl}/extended/v1/burnchain/reward_slot_holders/${address}`;
-    if (options) {
-      url = `${url}?limit=${options.limit}&offset=${options.offset}`;
-    }
-    return url;
-  };
-  getStackerInfoUrl = (contractAddress: string, contractName: string) =>
-    `${this.coreApiUrl}${this.readOnlyFunctionCallEndpoint}
-    ${contractAddress}/${contractName}/get-stacker-info`;
-  getDataVarUrl = (contractAddress: string, contractName: string, dataVarName: string) =>
-    `${this.coreApiUrl}/v2/data_var/${contractAddress}/${contractName}/${dataVarName}?proof=0`;
-  getMapEntryUrl = (contractAddress: string, contractName: string, mapName: string) =>
-    `${this.coreApiUrl}/v2/map_entry/${contractAddress}/${contractName}/${mapName}?proof=0`;
-  getNameInfo(fullyQualifiedName: string) {
-    /*
-      TODO: Update to v2 API URL for name lookups
-    */
-    const nameLookupURL = `${this.bnsLookupUrl}/v1/names/${fullyQualifiedName}`;
-    return this.fetchFn(nameLookupURL)
-      .then(resp => {
-        if (resp.status === 404) {
-          throw new Error('Name not found');
-        } else if (resp.status !== 200) {
-          throw new Error(`Bad response status: ${resp.status}`);
-        } else {
-          return resp.json();
-        }
-      })
-      .then(nameInfo => {
-        // the returned address _should_ be in the correct network ---
-        //  stacks node gets into trouble because it tries to coerce back to mainnet
-        //  and the regtest transaction generation libraries want to use testnet addresses
-        if (nameInfo.address) {
-          return Object.assign({}, nameInfo, { address: nameInfo.address });
-        } else {
-          return nameInfo;
-        }
-      });
-  }
-}
-
-/**
- * A {@link StacksNetwork} with the parameters for the Stacks mainnet.
- * Pass a `url` option to override the default Hiro hosted Stacks node API.
- * Pass a `fetchFn` option to customize the default networking functions.
+ * Returns the default network for a given name
  * @example
+ * ```ts
+ * networkFromName('mainnet') // same as STACKS_MAINNET
+ * networkFromName('testnet') // same as STACKS_TESTNET
+ * networkFromName('devnet') // same as STACKS_DEVNET
+ * networkFromName('mocknet') // same as STACKS_MOCKNET
  * ```
- * const network = new StacksMainnet();
- * const network = new StacksMainnet({ url: "https://api.mainnet.hiro.so" });
- * const network = new StacksMainnet({ fetch: createFetchFn() });
- * ```
- * @related {@link createFetchFn}, {@link createApiKeyMiddleware}
  */
-export class StacksMainnet extends StacksNetwork {
-  version = TransactionVersion.Mainnet;
-  chainId = ChainID.Mainnet;
-
-  constructor(opts?: Partial<NetworkConfig>) {
-    super({
-      url: opts?.url ?? HIRO_MAINNET_DEFAULT,
-      fetchFn: opts?.fetchFn,
-    });
+export function networkFromName(name: StacksNetworkName) {
+  switch (name) {
+    case 'mainnet':
+      return STACKS_MAINNET;
+    case 'testnet':
+      return STACKS_TESTNET;
+    case 'devnet':
+      return STACKS_DEVNET;
+    case 'mocknet':
+      return STACKS_MOCKNET;
+    default:
+      throw new Error(`Unknown network name: ${name}`);
   }
 }
 
-/**
- * A {@link StacksNetwork} with the parameters for the Stacks testnet.
- * Pass a `url` option to override the default Hiro hosted Stacks node API.
- * Pass a `fetchFn` option to customize the default networking functions.
- * @example
- * ```
- * const network = new StacksTestnet();
- * const network = new StacksTestnet({ url: "https://api.testnet.hiro.so" });
- * const network = new StacksTestnet({ fetch: createFetchFn() });
- * ```
- * @related {@link createFetchFn}, {@link createApiKeyMiddleware}
- */
-export class StacksTestnet extends StacksNetwork {
-  version = TransactionVersion.Testnet;
-  chainId = ChainID.Testnet;
+/** @ignore */
+export function networkFrom(network: StacksNetworkName | StacksNetwork) {
+  if (typeof network === 'string') return networkFromName(network);
+  return network;
+}
 
-  constructor(opts?: Partial<NetworkConfig>) {
-    super({
-      url: opts?.url ?? HIRO_TESTNET_DEFAULT,
-      fetchFn: opts?.fetchFn,
-    });
-  }
+/** @ignore */
+export function defaultUrlFromNetwork(network?: StacksNetworkName | StacksNetwork) {
+  if (!network) return HIRO_MAINNET_URL; // default to mainnet if no network is given
+
+  network = networkFrom(network);
+
+  return !network || network.transactionVersion === TransactionVersion.Mainnet
+    ? HIRO_MAINNET_URL // default to mainnet if txVersion is mainnet
+    : network.magicBytes === 'id'
+      ? DEVNET_URL // default to devnet if magicBytes are devnet
+      : HIRO_TESTNET_URL;
 }
 
 /**
- * A {@link StacksNetwork} using the testnet parameters, but `localhost:3999` as the API URL.
+ * Returns the client of a network, creating a new fetch function if none is available
  */
-export class StacksMocknet extends StacksNetwork {
-  version = TransactionVersion.Testnet;
-  chainId = ChainID.Testnet;
-
-  constructor(opts?: Partial<NetworkConfig>) {
-    super({
-      url: opts?.url ?? HIRO_MOCKNET_DEFAULT,
-      fetchFn: opts?.fetchFn,
-    });
-  }
+export function clientFromNetwork(network: StacksNetwork): Required<ClientOpts> {
+  if (network.client.fetch) return network.client as Required<ClientOpts>;
+  return {
+    ...network.client,
+    fetch: createFetchFn(),
+  };
 }
-
-/** Alias for {@link StacksMocknet} */
-export const StacksDevnet = StacksMocknet;

package/dist/esm/fetch.d.ts

@@ -1,31 +0,0 @@
-import 'cross-fetch/polyfill';
-export declare const getFetchOptions: () => RequestInit;
-export declare const setFetchOptions: (ops: RequestInit) => RequestInit;
-export type FetchFn = (url: string, init?: RequestInit) => Promise<Response>;
-export interface RequestContext {
-    fetch: FetchFn;
-    url: string;
-    init: RequestInit;
-}
-export interface ResponseContext {
-    fetch: FetchFn;
-    url: string;
-    init: RequestInit;
-    response: Response;
-}
-export interface FetchParams {
-    url: string;
-    init: RequestInit;
-}
-export interface FetchMiddleware {
-    pre?: (context: RequestContext) => PromiseLike<FetchParams | void> | FetchParams | void;
-    post?: (context: ResponseContext) => Promise<Response | void> | Response | void;
-}
-export interface ApiKeyMiddlewareOpts {
-    host?: RegExp | string;
-    httpHeader?: string;
-    apiKey: string;
-}
-export declare function createApiKeyMiddleware({ apiKey, host, httpHeader, }: ApiKeyMiddlewareOpts): FetchMiddleware;
-export declare function createFetchFn(fetchLib: FetchFn, ...middleware: FetchMiddleware[]): FetchFn;
-export declare function createFetchFn(...middleware: FetchMiddleware[]): FetchFn;

package/dist/esm/fetch.js

@@ -1,78 +0,0 @@
-import 'cross-fetch/polyfill';
-const defaultFetchOpts = {
-    referrerPolicy: 'origin',
-    headers: {
-        'x-hiro-product': 'stacksjs',
-    },
-};
-export const getFetchOptions = () => {
-    return defaultFetchOpts;
-};
-export const setFetchOptions = (ops) => {
-    return Object.assign(defaultFetchOpts, ops);
-};
-export async function fetchWrapper(input, init) {
-    const fetchOpts = {};
-    Object.assign(fetchOpts, defaultFetchOpts, init);
-    const fetchResult = await fetch(input, fetchOpts);
-    return fetchResult;
-}
-export function hostMatches(host, pattern) {
-    if (typeof pattern === 'string')
-        return pattern === host;
-    return pattern.exec(host);
-}
-export function createApiKeyMiddleware({ apiKey, host = /(.*)api(.*)(\.stacks\.co|\.hiro\.so)$/i, httpHeader = 'x-api-key', }) {
-    return {
-        pre: context => {
-            const reqUrl = new URL(context.url);
-            if (!hostMatches(reqUrl.host, host))
-                return;
-            const headers = context.init.headers instanceof Headers
-                ? context.init.headers
-                : (context.init.headers = new Headers(context.init.headers));
-            headers.set(httpHeader, apiKey);
-        },
-    };
-}
-function argsForCreateFetchFn(args) {
-    let fetchLib = fetchWrapper;
-    let middlewares = [];
-    if (args.length > 0 && typeof args[0] === 'function') {
-        fetchLib = args.shift();
-    }
-    if (args.length > 0) {
-        middlewares = args;
-    }
-    return { fetchLib, middlewares };
-}
-export function createFetchFn(...args) {
-    const { fetchLib, middlewares } = argsForCreateFetchFn(args);
-    const fetchFn = async (url, init) => {
-        let fetchParams = { url, init: init ?? {} };
-        for (const middleware of middlewares) {
-            if (typeof middleware.pre === 'function') {
-                const result = await Promise.resolve(middleware.pre({
-                    fetch: fetchLib,
-                    ...fetchParams,
-                }));
-                fetchParams = result ?? fetchParams;
-            }
-        }
-        let response = await fetchLib(fetchParams.url, fetchParams.init);
-        for (const middleware of middlewares) {
-            if (typeof middleware.post === 'function') {
-                const result = await Promise.resolve(middleware.post({
-                    fetch: fetchLib,
-                    url: fetchParams.url,
-                    init: fetchParams.init,
-                    response: response?.clone() ?? response,
-                }));
-                response = result ?? response;
-            }
-        }
-        return response;
-    };
-    return fetchFn;
-}
-//# sourceMappingURL=fetch.js.map

package/dist/esm/fetch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAI9B,MAAM,gBAAgB,GAAgB;IAGpC,cAAc,EAAE,QAAQ;IACxB,OAAO,EAAE;QACP,gBAAgB,EAAE,UAAU;KAC7B;CACF,CAAC;AAMF,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAiBF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAgB,EAAe,EAAE;IAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC,CAAC;AAGF,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,KAAkB,EAAE,IAAkB;IACvE,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAClD,OAAO,WAAW,CAAC;AACrB,CAAC;AAoCD,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,OAAwB;IAChE,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,OAAO,KAAK,IAAI,CAAC;IACzD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAaD,MAAM,UAAU,sBAAsB,CAAC,EACrC,MAAM,EACN,IAAI,GAAG,wCAAwC,EAC/C,UAAU,GAAG,WAAW,GACH;IACrB,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;gBAAE,OAAO;YAE5C,MAAM,OAAO,GACX,OAAO,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO;gBACrC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO;gBACtB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YACjE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAClC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAW;IACvC,IAAI,QAAQ,GAAY,YAAY,CAAC;IACrC,IAAI,WAAW,GAAsB,EAAE,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;QACpD,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;KACzB;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,WAAW,GAAG,IAAI,CAAC;KACpB;IACD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACnC,CAAC;AAcD,MAAM,UAAU,aAAa,CAAC,GAAG,IAAW;IAC1C,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG,KAAK,EAAE,GAAW,EAAE,IAA8B,EAAqB,EAAE;QACvF,IAAI,WAAW,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;QAE5C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE;gBACxC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAClC,UAAU,CAAC,GAAG,CAAC;oBACb,KAAK,EAAE,QAAQ;oBACf,GAAG,WAAW;iBACf,CAAC,CACH,CAAC;gBACF,WAAW,GAAG,MAAM,IAAI,WAAW,CAAC;aACrC;SACF;QAED,IAAI,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAEjE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE;gBACzC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAClC,UAAU,CAAC,IAAI,CAAC;oBACd,KAAK,EAAE,QAAQ;oBACf,GAAG,EAAE,WAAW,CAAC,GAAG;oBACpB,IAAI,EAAE,WAAW,CAAC,IAAI;oBACtB,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,QAAQ;iBACxC,CAAC,CACH,CAAC;gBACF,QAAQ,GAAG,MAAM,IAAI,QAAQ,CAAC;aAC/B;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/fetch.d.ts

@@ -1,31 +0,0 @@
-import 'cross-fetch/polyfill';
-export declare const getFetchOptions: () => RequestInit;
-export declare const setFetchOptions: (ops: RequestInit) => RequestInit;
-export type FetchFn = (url: string, init?: RequestInit) => Promise<Response>;
-export interface RequestContext {
-    fetch: FetchFn;
-    url: string;
-    init: RequestInit;
-}
-export interface ResponseContext {
-    fetch: FetchFn;
-    url: string;
-    init: RequestInit;
-    response: Response;
-}
-export interface FetchParams {
-    url: string;
-    init: RequestInit;
-}
-export interface FetchMiddleware {
-    pre?: (context: RequestContext) => PromiseLike<FetchParams | void> | FetchParams | void;
-    post?: (context: ResponseContext) => Promise<Response | void> | Response | void;
-}
-export interface ApiKeyMiddlewareOpts {
-    host?: RegExp | string;
-    httpHeader?: string;
-    apiKey: string;
-}
-export declare function createApiKeyMiddleware({ apiKey, host, httpHeader, }: ApiKeyMiddlewareOpts): FetchMiddleware;
-export declare function createFetchFn(fetchLib: FetchFn, ...middleware: FetchMiddleware[]): FetchFn;
-export declare function createFetchFn(...middleware: FetchMiddleware[]): FetchFn;

package/dist/fetch.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFetchFn = exports.createApiKeyMiddleware = exports.hostMatches = exports.fetchWrapper = exports.setFetchOptions = exports.getFetchOptions = void 0;
-require("cross-fetch/polyfill");
-const defaultFetchOpts = {
-    referrerPolicy: 'origin',
-    headers: {
-        'x-hiro-product': 'stacksjs',
-    },
-};
-const getFetchOptions = () => {
-    return defaultFetchOpts;
-};
-exports.getFetchOptions = getFetchOptions;
-const setFetchOptions = (ops) => {
-    return Object.assign(defaultFetchOpts, ops);
-};
-exports.setFetchOptions = setFetchOptions;
-async function fetchWrapper(input, init) {
-    const fetchOpts = {};
-    Object.assign(fetchOpts, defaultFetchOpts, init);
-    const fetchResult = await fetch(input, fetchOpts);
-    return fetchResult;
-}
-exports.fetchWrapper = fetchWrapper;
-function hostMatches(host, pattern) {
-    if (typeof pattern === 'string')
-        return pattern === host;
-    return pattern.exec(host);
-}
-exports.hostMatches = hostMatches;
-function createApiKeyMiddleware({ apiKey, host = /(.*)api(.*)(\.stacks\.co|\.hiro\.so)$/i, httpHeader = 'x-api-key', }) {
-    return {
-        pre: context => {
-            const reqUrl = new URL(context.url);
-            if (!hostMatches(reqUrl.host, host))
-                return;
-            const headers = context.init.headers instanceof Headers
-                ? context.init.headers
-                : (context.init.headers = new Headers(context.init.headers));
-            headers.set(httpHeader, apiKey);
-        },
-    };
-}
-exports.createApiKeyMiddleware = createApiKeyMiddleware;
-function argsForCreateFetchFn(args) {
-    let fetchLib = fetchWrapper;
-    let middlewares = [];
-    if (args.length > 0 && typeof args[0] === 'function') {
-        fetchLib = args.shift();
-    }
-    if (args.length > 0) {
-        middlewares = args;
-    }
-    return { fetchLib, middlewares };
-}
-function createFetchFn(...args) {
-    const { fetchLib, middlewares } = argsForCreateFetchFn(args);
-    const fetchFn = async (url, init) => {
-        let fetchParams = { url, init: init ?? {} };
-        for (const middleware of middlewares) {
-            if (typeof middleware.pre === 'function') {
-                const result = await Promise.resolve(middleware.pre({
-                    fetch: fetchLib,
-                    ...fetchParams,
-                }));
-                fetchParams = result ?? fetchParams;
-            }
-        }
-        let response = await fetchLib(fetchParams.url, fetchParams.init);
-        for (const middleware of middlewares) {
-            if (typeof middleware.post === 'function') {
-                const result = await Promise.resolve(middleware.post({
-                    fetch: fetchLib,
-                    url: fetchParams.url,
-                    init: fetchParams.init,
-                    response: response?.clone() ?? response,
-                }));
-                response = result ?? response;
-            }
-        }
-        return response;
-    };
-    return fetchFn;
-}
-exports.createFetchFn = createFetchFn;
-//# sourceMappingURL=fetch.js.map

package/dist/fetch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":";;;AAAA,gCAA8B;AAI9B,MAAM,gBAAgB,GAAgB;IAGpC,cAAc,EAAE,QAAQ;IACxB,OAAO,EAAE;QACP,gBAAgB,EAAE,UAAU;KAC7B;CACF,CAAC;AAMK,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAiBK,MAAM,eAAe,GAAG,CAAC,GAAgB,EAAe,EAAE;IAC/D,OAAO,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAGK,KAAK,UAAU,YAAY,CAAC,KAAkB,EAAE,IAAkB;IACvE,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAClD,OAAO,WAAW,CAAC;AACrB,CAAC;AAPD,oCAOC;AAoCD,SAAgB,WAAW,CAAC,IAAY,EAAE,OAAwB;IAChE,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,OAAO,KAAK,IAAI,CAAC;IACzD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAHD,kCAGC;AAaD,SAAgB,sBAAsB,CAAC,EACrC,MAAM,EACN,IAAI,GAAG,wCAAwC,EAC/C,UAAU,GAAG,WAAW,GACH;IACrB,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC;gBAAE,OAAO;YAE5C,MAAM,OAAO,GACX,OAAO,CAAC,IAAI,CAAC,OAAO,YAAY,OAAO;gBACrC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO;gBACtB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YACjE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAClC,CAAC;KACF,CAAC;AACJ,CAAC;AAjBD,wDAiBC;AAED,SAAS,oBAAoB,CAAC,IAAW;IACvC,IAAI,QAAQ,GAAY,YAAY,CAAC;IACrC,IAAI,WAAW,GAAsB,EAAE,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;QACpD,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;KACzB;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,WAAW,GAAG,IAAI,CAAC;KACpB;IACD,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACnC,CAAC;AAcD,SAAgB,aAAa,CAAC,GAAG,IAAW;IAC1C,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG,KAAK,EAAE,GAAW,EAAE,IAA8B,EAAqB,EAAE;QACvF,IAAI,WAAW,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;QAE5C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE;gBACxC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAClC,UAAU,CAAC,GAAG,CAAC;oBACb,KAAK,EAAE,QAAQ;oBACf,GAAG,WAAW;iBACf,CAAC,CACH,CAAC;gBACF,WAAW,GAAG,MAAM,IAAI,WAAW,CAAC;aACrC;SACF;QAED,IAAI,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAEjE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACpC,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE;gBACzC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAClC,UAAU,CAAC,IAAI,CAAC;oBACd,KAAK,EAAE,QAAQ;oBACf,GAAG,EAAE,WAAW,CAAC,GAAG;oBACpB,IAAI,EAAE,WAAW,CAAC,IAAI;oBACtB,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,QAAQ;iBACxC,CAAC,CACH,CAAC;gBACF,QAAQ,GAAG,MAAM,IAAI,QAAQ,CAAC;aAC/B;SACF;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AApCD,sCAoCC"}