@offlinejs/network 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { NetworkMonitor, NetworkState, SyncTransport, TransportOptions, TransportRequest, TransportResponse } from '@offlinejs/types';
+
+interface BrowserNetworkMonitorOptions {
+    initialOnline?: boolean;
+}
+declare class BrowserNetworkMonitor implements NetworkMonitor {
+    private listeners;
+    private state;
+    constructor(options?: BrowserNetworkMonitorOptions);
+    getState(): NetworkState;
+    isOnline(): boolean;
+    setOnline(online: boolean): void;
+    subscribe(listener: (state: NetworkState) => void): () => void;
+    destroy(): void;
+    private handleOnline;
+    private handleOffline;
+    private update;
+}
+type FetchTransportOptions = TransportOptions;
+declare class FetchTransport implements SyncTransport {
+    readonly contractVersion = 1;
+    private readonly baseURL;
+    private readonly fetchImplementation;
+    private readonly headers;
+    private readonly middlewares;
+    private readonly timeoutMs;
+    constructor(options: FetchTransportOptions);
+    request<TData = unknown, TBody = unknown>(request: TransportRequest<TBody>): Promise<TransportResponse<TData>>;
+    private resolveHeaders;
+    private applyMiddlewares;
+}
+declare const createNetworkMonitor: (options?: BrowserNetworkMonitorOptions) => BrowserNetworkMonitor;
+declare const createFetchTransport: (options: FetchTransportOptions) => FetchTransport;
+
+export { BrowserNetworkMonitor, type BrowserNetworkMonitorOptions, FetchTransport, type FetchTransportOptions, createFetchTransport, createNetworkMonitor };

package/dist/index.js

@@ -0,0 +1,128 @@
+import { SYNC_TRANSPORT_CONTRACT_VERSION } from '@offlinejs/types';
+import { toQueryString } from '@offlinejs/utils';
+
+// src/index.ts
+var BrowserNetworkMonitor = class {
+  listeners = /* @__PURE__ */ new Set();
+  state;
+  constructor(options = {}) {
+    const navigatorOnline = typeof globalThis.navigator !== "undefined" ? globalThis.navigator.onLine : true;
+    this.state = {
+      online: options.initialOnline ?? navigatorOnline,
+      since: Date.now()
+    };
+    globalThis.addEventListener?.("online", this.handleOnline);
+    globalThis.addEventListener?.("offline", this.handleOffline);
+  }
+  getState() {
+    return { ...this.state };
+  }
+  isOnline() {
+    return this.state.online;
+  }
+  setOnline(online) {
+    this.update(online);
+  }
+  subscribe(listener) {
+    this.listeners.add(listener);
+    listener(this.getState());
+    return () => {
+      this.listeners.delete(listener);
+    };
+  }
+  destroy() {
+    globalThis.removeEventListener?.("online", this.handleOnline);
+    globalThis.removeEventListener?.("offline", this.handleOffline);
+    this.listeners.clear();
+  }
+  handleOnline = () => {
+    this.update(true);
+  };
+  handleOffline = () => {
+    this.update(false);
+  };
+  update(online) {
+    if (this.state.online === online) {
+      return;
+    }
+    this.state = { online, since: Date.now() };
+    for (const listener of this.listeners) {
+      listener(this.getState());
+    }
+  }
+};
+var FetchTransport = class {
+  contractVersion = SYNC_TRANSPORT_CONTRACT_VERSION;
+  baseURL;
+  fetchImplementation;
+  headers;
+  middlewares;
+  timeoutMs;
+  constructor(options) {
+    this.baseURL = options.baseURL.replace(/\/$/, "");
+    this.fetchImplementation = options.fetch ?? globalThis.fetch;
+    this.headers = options.headers;
+    this.middlewares = options.middlewares ?? [];
+    this.timeoutMs = options.timeoutMs;
+    if (!this.fetchImplementation) {
+      throw new Error("A fetch implementation is required for this runtime");
+    }
+  }
+  async request(request) {
+    const preparedRequest = await this.applyMiddlewares(request);
+    const headers = {
+      "content-type": "application/json",
+      ...await this.resolveHeaders(),
+      ...preparedRequest.headers
+    };
+    const timeoutMs = preparedRequest.timeoutMs ?? this.timeoutMs;
+    const controller = timeoutMs ? new AbortController() : void 0;
+    const timeoutId = timeoutMs ? globalThis.setTimeout(() => controller?.abort(), timeoutMs) : void 0;
+    try {
+      const response = await this.fetchImplementation(
+        `${this.baseURL}${preparedRequest.path}${toQueryString(preparedRequest.query)}`,
+        {
+          headers,
+          method: preparedRequest.method,
+          ...controller ? { signal: controller.signal } : {},
+          ...preparedRequest.body === void 0 ? {} : { body: JSON.stringify(preparedRequest.body) }
+        }
+      );
+      const text = await response.text();
+      const data = text.length > 0 ? JSON.parse(text) : void 0;
+      if (!response.ok) {
+        const error = new Error(`Request failed with status ${response.status}`);
+        Object.assign(error, { data, status: response.status });
+        throw error;
+      }
+      return {
+        data,
+        status: response.status,
+        ...response.headers.get("etag") ? { etag: response.headers.get("etag") } : {}
+      };
+    } finally {
+      if (timeoutId) {
+        globalThis.clearTimeout(timeoutId);
+      }
+    }
+  }
+  async resolveHeaders() {
+    if (!this.headers) {
+      return {};
+    }
+    return typeof this.headers === "function" ? this.headers() : this.headers;
+  }
+  async applyMiddlewares(request) {
+    let nextRequest = request;
+    for (const middleware of this.middlewares) {
+      nextRequest = await middleware({ request: nextRequest });
+    }
+    return nextRequest;
+  }
+};
+var createNetworkMonitor = (options) => new BrowserNetworkMonitor(options);
+var createFetchTransport = (options) => new FetchTransport(options);
+
+export { BrowserNetworkMonitor, FetchTransport, createFetchTransport, createNetworkMonitor };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;AAeO,IAAM,wBAAN,MAAsD;AAAA,EACnD,SAAA,uBAAgB,GAAA,EAAmC;AAAA,EACnD,KAAA;AAAA,EAER,WAAA,CAAY,OAAA,GAAwC,EAAC,EAAG;AACtD,IAAA,MAAM,kBACJ,OAAO,UAAA,CAAW,cAAc,WAAA,GAAc,UAAA,CAAW,UAAU,MAAA,GAAS,IAAA;AAE9E,IAAA,IAAA,CAAK,KAAA,GAAQ;AAAA,MACX,MAAA,EAAQ,QAAQ,aAAA,IAAiB,eAAA;AAAA,MACjC,KAAA,EAAO,KAAK,GAAA;AAAI,KAClB;AAEA,IAAA,UAAA,CAAW,gBAAA,GAAmB,QAAA,EAAU,IAAA,CAAK,YAAY,CAAA;AACzD,IAAA,UAAA,CAAW,gBAAA,GAAmB,SAAA,EAAW,IAAA,CAAK,aAAa,CAAA;AAAA,EAC7D;AAAA,EAEA,QAAA,GAAyB;AACvB,IAAA,OAAO,EAAE,GAAG,IAAA,CAAK,KAAA,EAAM;AAAA,EACzB;AAAA,EAEA,QAAA,GAAoB;AAClB,IAAA,OAAO,KAAK,KAAA,CAAM,MAAA;AAAA,EACpB;AAAA,EAEA,UAAU,MAAA,EAAuB;AAC/B,IAAA,IAAA,CAAK,OAAO,MAAM,CAAA;AAAA,EACpB;AAAA,EAEA,UAAU,QAAA,EAAqD;AAC7D,IAAA,IAAA,CAAK,SAAA,CAAU,IAAI,QAAQ,CAAA;AAC3B,IAAA,QAAA,CAAS,IAAA,CAAK,UAAU,CAAA;AAExB,IAAA,OAAO,MAAM;AACX,MAAA,IAAA,CAAK,SAAA,CAAU,OAAO,QAAQ,CAAA;AAAA,IAChC,CAAA;AAAA,EACF;AAAA,EAEA,OAAA,GAAgB;AACd,IAAA,UAAA,CAAW,mBAAA,GAAsB,QAAA,EAAU,IAAA,CAAK,YAAY,CAAA;AAC5D,IAAA,UAAA,CAAW,mBAAA,GAAsB,SAAA,EAAW,IAAA,CAAK,aAAa,CAAA;AAC9D,IAAA,IAAA,CAAK,UAAU,KAAA,EAAM;AAAA,EACvB;AAAA,EAEQ,eAAe,MAAY;AACjC,IAAA,IAAA,CAAK,OAAO,IAAI,CAAA;AAAA,EAClB,CAAA;AAAA,EAEQ,gBAAgB,MAAY;AAClC,IAAA,IAAA,CAAK,OAAO,KAAK,CAAA;AAAA,EACnB,CAAA;AAAA,EAEQ,OAAO,MAAA,EAAuB;AACpC,IAAA,IAAI,IAAA,CAAK,KAAA,CAAM,MAAA,KAAW,MAAA,EAAQ;AAChC,MAAA;AAAA,IACF;AAEA,IAAA,IAAA,CAAK,QAAQ,EAAE,MAAA,EAAQ,KAAA,EAAO,IAAA,CAAK,KAAI,EAAE;AAEzC,IAAA,KAAA,MAAW,QAAA,IAAY,KAAK,SAAA,EAAW;AACrC,MAAA,QAAA,CAAS,IAAA,CAAK,UAAU,CAAA;AAAA,IAC1B;AAAA,EACF;AACF;AAIO,IAAM,iBAAN,MAA8C;AAAA,EAC1C,eAAA,GAAkB,+BAAA;AAAA,EAEV,OAAA;AAAA,EACA,mBAAA;AAAA,EACA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,SAAA;AAAA,EAEjB,YAAY,OAAA,EAAgC;AAC1C,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA,CAAQ,OAAA,CAAQ,OAAA,CAAQ,OAAO,EAAE,CAAA;AAChD,IAAA,IAAA,CAAK,mBAAA,GAAsB,OAAA,CAAQ,KAAA,IAAS,UAAA,CAAW,KAAA;AACvD,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,OAAA;AACvB,IAAA,IAAA,CAAK,WAAA,GAAc,OAAA,CAAQ,WAAA,IAAe,EAAC;AAC3C,IAAA,IAAA,CAAK,YAAY,OAAA,CAAQ,SAAA;AAEzB,IAAA,IAAI,CAAC,KAAK,mBAAA,EAAqB;AAC7B,MAAA,MAAM,IAAI,MAAM,qDAAqD,CAAA;AAAA,IACvE;AAAA,EACF;AAAA,EAEA,MAAM,QACJ,OAAA,EACmC;AACnC,IAAA,MAAM,eAAA,GAAkB,MAAM,IAAA,CAAK,gBAAA,CAAiB,OAAO,CAAA;AAC3D,IAAA,MAAM,OAAA,GAAU;AAAA,MACd,cAAA,EAAgB,kBAAA;AAAA,MAChB,GAAI,MAAM,IAAA,CAAK,cAAA,EAAe;AAAA,MAC9B,GAAG,eAAA,CAAgB;AAAA,KACrB;AACA,IAAA,MAAM,SAAA,GAAY,eAAA,CAAgB,SAAA,IAAa,IAAA,CAAK,SAAA;AACpD,IAAA,MAAM,UAAA,GAAa,SAAA,GAAY,IAAI,eAAA,EAAgB,GAAI,MAAA;AACvD,IAAA,MAAM,SAAA,GAAY,YACd,UAAA,CAAW,UAAA,CAAW,MAAM,UAAA,EAAY,KAAA,EAAM,EAAG,SAAS,CAAA,GAC1D,MAAA;AAEJ,IAAA,IAAI;AACF,MAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,mBAAA;AAAA,QAC1B,CAAA,EAAG,IAAA,CAAK,OAAO,CAAA,EAAG,eAAA,CAAgB,IAAI,CAAA,EAAG,aAAA,CAAc,eAAA,CAAgB,KAAK,CAAC,CAAA,CAAA;AAAA,QAC7E;AAAA,UACE,OAAA;AAAA,UACA,QAAQ,eAAA,CAAgB,MAAA;AAAA,UACxB,GAAI,UAAA,GAAa,EAAE,QAAQ,UAAA,CAAW,MAAA,KAAW,EAAC;AAAA,UAClD,GAAI,eAAA,CAAgB,IAAA,KAAS,KAAA,CAAA,GACzB,EAAC,GACD,EAAE,IAAA,EAAM,IAAA,CAAK,SAAA,CAAU,eAAA,CAAgB,IAAI,CAAA;AAAE;AACnD,OACF;AAEA,MAAA,MAAM,IAAA,GAAO,MAAM,QAAA,CAAS,IAAA,EAAK;AACjC,MAAA,MAAM,OAAO,IAAA,CAAK,MAAA,GAAS,IAAK,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA,GAAe,KAAA,CAAA;AAE9D,MAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,QAAA,MAAM,QAAQ,IAAI,KAAA,CAAM,CAAA,2BAAA,EAA8B,QAAA,CAAS,MAAM,CAAA,CAAE,CAAA;AACvE,QAAA,MAAA,CAAO,OAAO,KAAA,EAAO,EAAE,MAAM,MAAA,EAAQ,QAAA,CAAS,QAAQ,CAAA;AACtD,QAAA,MAAM,KAAA;AAAA,MACR;AAEA,MAAA,OAAO;AAAA,QACL,IAAA;AAAA,QACA,QAAQ,QAAA,CAAS,MAAA;AAAA,QACjB,GAAI,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,GAAI,EAAE,IAAA,EAAM,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,MAAM,CAAA,KAAgB;AAAC,OACzF;AAAA,IACF,CAAA,SAAE;AACA,MAAA,IAAI,SAAA,EAAW;AACb,QAAA,UAAA,CAAW,aAAa,SAAS,CAAA;AAAA,MACnC;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,cAAA,GAAkD;AAC9D,IAAA,IAAI,CAAC,KAAK,OAAA,EAAS;AACjB,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,OAAO,OAAO,IAAA,CAAK,OAAA,KAAY,aAAa,IAAA,CAAK,OAAA,KAAY,IAAA,CAAK,OAAA;AAAA,EACpE;AAAA,EAEA,MAAc,iBACZ,OAAA,EACkC;AAClC,IAAA,IAAI,WAAA,GAAc,OAAA;AAElB,IAAA,KAAA,MAAW,UAAA,IAAc,KAAK,WAAA,EAAa;AACzC,MAAA,WAAA,GAAc,MAAM,UAAA,CAAW,EAAE,OAAA,EAAS,aAAa,CAAA;AAAA,IACzD;AAEA,IAAA,OAAO,WAAA;AAAA,EACT;AACF;AAEO,IAAM,oBAAA,GAAuB,CAClC,OAAA,KAC0B,IAAI,sBAAsB,OAAO;AAEtD,IAAM,oBAAA,GAAuB,CAAC,OAAA,KACnC,IAAI,eAAe,OAAO","file":"index.js","sourcesContent":["import {\n  SYNC_TRANSPORT_CONTRACT_VERSION,\n  type NetworkMonitor,\n  type NetworkState,\n  type SyncTransport,\n  type TransportOptions,\n  type TransportRequest,\n  type TransportResponse\n} from \"@offlinejs/types\";\nimport { toQueryString } from \"@offlinejs/utils\";\n\nexport interface BrowserNetworkMonitorOptions {\n  initialOnline?: boolean;\n}\n\nexport class BrowserNetworkMonitor implements NetworkMonitor {\n  private listeners = new Set<(state: NetworkState) => void>();\n  private state: NetworkState;\n\n  constructor(options: BrowserNetworkMonitorOptions = {}) {\n    const navigatorOnline =\n      typeof globalThis.navigator !== \"undefined\" ? globalThis.navigator.onLine : true;\n\n    this.state = {\n      online: options.initialOnline ?? navigatorOnline,\n      since: Date.now()\n    };\n\n    globalThis.addEventListener?.(\"online\", this.handleOnline);\n    globalThis.addEventListener?.(\"offline\", this.handleOffline);\n  }\n\n  getState(): NetworkState {\n    return { ...this.state };\n  }\n\n  isOnline(): boolean {\n    return this.state.online;\n  }\n\n  setOnline(online: boolean): void {\n    this.update(online);\n  }\n\n  subscribe(listener: (state: NetworkState) => void): () => void {\n    this.listeners.add(listener);\n    listener(this.getState());\n\n    return () => {\n      this.listeners.delete(listener);\n    };\n  }\n\n  destroy(): void {\n    globalThis.removeEventListener?.(\"online\", this.handleOnline);\n    globalThis.removeEventListener?.(\"offline\", this.handleOffline);\n    this.listeners.clear();\n  }\n\n  private handleOnline = (): void => {\n    this.update(true);\n  };\n\n  private handleOffline = (): void => {\n    this.update(false);\n  };\n\n  private update(online: boolean): void {\n    if (this.state.online === online) {\n      return;\n    }\n\n    this.state = { online, since: Date.now() };\n\n    for (const listener of this.listeners) {\n      listener(this.getState());\n    }\n  }\n}\n\nexport type FetchTransportOptions = TransportOptions;\n\nexport class FetchTransport implements SyncTransport {\n  readonly contractVersion = SYNC_TRANSPORT_CONTRACT_VERSION;\n\n  private readonly baseURL: string;\n  private readonly fetchImplementation: typeof fetch;\n  private readonly headers: FetchTransportOptions[\"headers\"] | undefined;\n  private readonly middlewares: NonNullable<FetchTransportOptions[\"middlewares\"]>;\n  private readonly timeoutMs: number | undefined;\n\n  constructor(options: FetchTransportOptions) {\n    this.baseURL = options.baseURL.replace(/\\/$/, \"\");\n    this.fetchImplementation = options.fetch ?? globalThis.fetch;\n    this.headers = options.headers;\n    this.middlewares = options.middlewares ?? [];\n    this.timeoutMs = options.timeoutMs;\n\n    if (!this.fetchImplementation) {\n      throw new Error(\"A fetch implementation is required for this runtime\");\n    }\n  }\n\n  async request<TData = unknown, TBody = unknown>(\n    request: TransportRequest<TBody>\n  ): Promise<TransportResponse<TData>> {\n    const preparedRequest = await this.applyMiddlewares(request);\n    const headers = {\n      \"content-type\": \"application/json\",\n      ...(await this.resolveHeaders()),\n      ...preparedRequest.headers\n    };\n    const timeoutMs = preparedRequest.timeoutMs ?? this.timeoutMs;\n    const controller = timeoutMs ? new AbortController() : undefined;\n    const timeoutId = timeoutMs\n      ? globalThis.setTimeout(() => controller?.abort(), timeoutMs)\n      : undefined;\n\n    try {\n      const response = await this.fetchImplementation(\n        `${this.baseURL}${preparedRequest.path}${toQueryString(preparedRequest.query)}`,\n        {\n          headers,\n          method: preparedRequest.method,\n          ...(controller ? { signal: controller.signal } : {}),\n          ...(preparedRequest.body === undefined\n            ? {}\n            : { body: JSON.stringify(preparedRequest.body) })\n        }\n      );\n\n      const text = await response.text();\n      const data = text.length > 0 ? (JSON.parse(text) as TData) : (undefined as TData);\n\n      if (!response.ok) {\n        const error = new Error(`Request failed with status ${response.status}`);\n        Object.assign(error, { data, status: response.status });\n        throw error;\n      }\n\n      return {\n        data,\n        status: response.status,\n        ...(response.headers.get(\"etag\") ? { etag: response.headers.get(\"etag\") as string } : {})\n      };\n    } finally {\n      if (timeoutId) {\n        globalThis.clearTimeout(timeoutId);\n      }\n    }\n  }\n\n  private async resolveHeaders(): Promise<Record<string, string>> {\n    if (!this.headers) {\n      return {};\n    }\n\n    return typeof this.headers === \"function\" ? this.headers() : this.headers;\n  }\n\n  private async applyMiddlewares<TBody>(\n    request: TransportRequest<TBody>\n  ): Promise<TransportRequest<TBody>> {\n    let nextRequest = request;\n\n    for (const middleware of this.middlewares) {\n      nextRequest = await middleware({ request: nextRequest });\n    }\n\n    return nextRequest;\n  }\n}\n\nexport const createNetworkMonitor = (\n  options?: BrowserNetworkMonitorOptions\n): BrowserNetworkMonitor => new BrowserNetworkMonitor(options);\n\nexport const createFetchTransport = (options: FetchTransportOptions): FetchTransport =>\n  new FetchTransport(options);\n"]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@offlinejs/network",
+  "version": "0.1.0",
+  "description": "Network detection and fetch transport for OfflineJS.",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@offlinejs/utils": "0.1.0",
+    "@offlinejs/types": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "latest",
+    "typescript": "latest"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit"
+  }
+}