@pikku/fetch 0.6.1 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @pikku/fetch
 
+## 0.7.0
+
+- Updating to match remaining packages
+
+## 0.6.2
+
+### Patch Changes
+
+- 3062086: fix: renaming AbstractFetch/Websocket to core
+
 ## 0.6.1
 
 ### Patch Changes

package/dist/cjs/index.d.ts

@@ -6,5 +6,5 @@
  *
  * @module @pikku/fetch
  */
-export { CorePikkuFetch, CorePikkuFetchOptions, HTTPMethod, } from './abstract-pikku-fetch.js';
+export { CorePikkuFetch, CorePikkuFetchOptions, HTTPMethod, } from './core-pikku-fetch.js';
 export { corePikkuFetch } from './pikku-fetch.js';

package/dist/cjs/index.js

@@ -9,7 +9,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.corePikkuFetch = exports.CorePikkuFetch = void 0;
-var abstract_pikku_fetch_js_1 = require("./abstract-pikku-fetch.js");
-Object.defineProperty(exports, "CorePikkuFetch", { enumerable: true, get: function () { return abstract_pikku_fetch_js_1.CorePikkuFetch; } });
+var core_pikku_fetch_js_1 = require("./core-pikku-fetch.js");
+Object.defineProperty(exports, "CorePikkuFetch", { enumerable: true, get: function () { return core_pikku_fetch_js_1.CorePikkuFetch; } });
 var pikku_fetch_js_1 = require("./pikku-fetch.js");
 Object.defineProperty(exports, "corePikkuFetch", { enumerable: true, get: function () { return pikku_fetch_js_1.corePikkuFetch; } });

package/dist/esm/index.d.ts

@@ -6,5 +6,5 @@
  *
  * @module @pikku/fetch
  */
-export { CorePikkuFetch, CorePikkuFetchOptions, HTTPMethod, } from './abstract-pikku-fetch.js';
+export { CorePikkuFetch, CorePikkuFetchOptions, HTTPMethod, } from './core-pikku-fetch.js';
 export { corePikkuFetch } from './pikku-fetch.js';

package/dist/esm/index.js

@@ -6,5 +6,5 @@
  *
  * @module @pikku/fetch
  */
-export { CorePikkuFetch, } from './abstract-pikku-fetch.js';
+export { CorePikkuFetch, } from './core-pikku-fetch.js';
 export { corePikkuFetch } from './pikku-fetch.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/fetch",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "build:esm": "tsc -b && echo '{\"type\": \"module\"}' > dist/esm/package.json",
     "build:cjs": "tsc -b tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
     "build": "yarn build:esm && yarn build:cjs",
-    "ncu": "ncu -x '/.*glob.*/'",
+    "ncu": "npx npm-check-updates -x '/.*glob.*/'",
     "release": "yarn build && npm test",
     "test": "bash run-tests.sh",
     "test:watch": "bash run-tests.sh --watch",

package/dist/tsconfig.cjs.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../src/abstract-pikku-fetch.ts","../src/index.ts","../src/pikku-fetch.ts","../src/transform-date.ts"],"version":"5.7.3"}

package/dist/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../src/abstract-pikku-fetch.ts","../src/index.ts","../src/pikku-fetch.ts","../src/transform-date.ts"],"version":"5.7.3"}

package/src/abstract-pikku-fetch.ts

@@ -1,200 +0,0 @@
-import { transformDates } from './transform-date.js'
-import { corePikkuFetch } from './pikku-fetch.js'
-
-type AuthHeaders = {
-  jwt?: string
-  apiKey?: string
-}
-
-export type HTTPMethod = 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'HEAD' | 'PUT'
-
-/**
- * Options for configuring the `CorePikkuFetch` utility.
- *
- * @typedef {Object} CorePikkuFetchOptions
- * @property {boolean} [transformDate] - Whether to transform date-like strings in the response to `Date` objects.
- * @property {string} [serverUrl] - The base server URL for requests.
- * @property {AuthHeaders} [authHeaders] - Authorization headers, including JWT or API key.
- * @property {RequestInit['cache']} [cache] - The cache mode for the request.
- * @property {RequestInit['credentials']} [credentials] - The credentials mode for the request.
- * @property {RequestInit['mode']} [mode] - The mode for the request.
- */
-export type CorePikkuFetchOptions = {
-  transformDate?: boolean
-  serverUrl?: string
-  authHeaders?: AuthHeaders
-} & Pick<RequestInit, 'cache' | 'credentials' | 'mode'>
-
-/**
- * The `CorePikkuFetch` class provides a utility for making HTTP requests, including handling authorization,
- * transforming dates in responses, and managing server URLs. This class is designed to simplify API interactions
- * with configurable options and support for JWT and API key-based authentication.
- */
-export class CorePikkuFetch {
-  private authHeaders: AuthHeaders = {}
-
-  /**
-   * Constructs a new instance of the `CorePikkuFetch` class.
-   *
-   * @param {CorePikkuFetchOptions} options - Optional configuration for the fetch utility.
-   */
-  constructor(private options: CorePikkuFetchOptions = {}) {
-    this.authHeaders = options.authHeaders || {}
-  }
-
-  /**
-   * Generates the headers for the request, including authorization headers if set.
-   *
-   * @returns {Record<string, string>} - The headers for the request.
-   */
-  private getHeaders(): Record<string, string> {
-    const headers: Record<string, string> = {
-      'Content-Type': 'application/json',
-    }
-    if (this.authHeaders.jwt) {
-      headers.Authorization = `Bearer ${this.authHeaders.jwt}`
-    } else if (this.authHeaders.apiKey) {
-      headers['X-API-KEY'] = this.authHeaders.apiKey
-    }
-    return headers
-  }
-
-  /**
-   * Sets the server URL for subsequent requests.
-   *
-   * @param {string} serverUrl - The server URL to be set.
-   */
-  public async setServerUrl(serverUrl: string): Promise<void> {
-    if (serverUrl.endsWith('/')) {
-      console.warn('Server URL should not end with a slash, removing.')
-      serverUrl = serverUrl.slice(0, -1)
-    }
-    this.options.serverUrl = serverUrl
-  }
-
-  /**
-   * Sets the JWT for authorization.
-   *
-   * @param {string} jwt - The JWT to be used for authorization.
-   */
-  public setAuthorizationJWT(jwt: string | null): void {
-    if (jwt) {
-      this.authHeaders.jwt = jwt
-    } else {
-      delete this.authHeaders.jwt
-    }
-  }
-
-  /**
-   * Sets the API key for authorization.
-   *
-   * @param {string} [apiKey] - The API key to be used for authorization.
-   */
-  public setAPIKey(apiKey: string | null): void {
-    if (apiKey) {
-      this.authHeaders.apiKey = apiKey
-    } else {
-      delete this.authHeaders.apiKey
-    }
-  }
-
-  public async post(uri: string, data: any, options?: RequestInit) {
-    return await this.api(uri, 'POST', data, options)
-  }
-
-  public async get(uri: string, data: any, options?: RequestInit) {
-    return await this.api(uri, 'GET', data, options)
-  }
-
-  public async patch(uri: string, data: any, options?: RequestInit) {
-    return await this.api(uri, 'PATCH', data, options)
-  }
-
-  public async head(uri: string, data: any, options?: RequestInit) {
-    return await this.api(uri, 'HEAD', data, options)
-  }
-
-  /**
-   * Makes an API request with the specified URI, method, and data, and optionally transforms dates in the response.
-   *
-   * @param {string} uri - The endpoint URI for the request.
-   * @param {HTTPMethod} method - The HTTP method for the request.
-   * @param {any} data - The data to be sent with the request.
-   * @param {RequestInit} [options] - Additional options for the request.
-   * @returns {Promise<any>} - A promise that resolves to the response data.
-   * @throws {Response} - Throws the response if the status code is greater than 400.
-   */
-  public async api(
-    uri: string,
-    method: HTTPMethod,
-    data: any,
-    options?: RequestInit
-  ) {
-    const response = await this.fetch(uri, method, data, options)
-    if (response.status >= 400) {
-      throw response
-    }
-    try {
-      const result = await response.json()
-      return this.transformDates(result)
-    } catch {
-      // TODO: If it doesn't return anything..
-      return
-    }
-  }
-
-  /**
-   * Makes a raw fetch request with the specified URI, method, and data.
-   *
-   * @param {string} uri - The endpoint URI for the request.
-   * @param {HTTPMethod} method - The HTTP method for the request.
-   * @param {any} data - The data to be sent with the request.
-   * @param {RequestInit} [options] - Additional options for the request.
-   * @returns {Promise<Response>} - A promise that resolves to the fetch response.
-   */
-  public async fetch(
-    uri: string,
-    method: HTTPMethod,
-    data: any,
-    options?: RequestInit
-  ) {
-    this.verifyServerUrlSet()
-    if (uri.startsWith('/')) {
-      uri = `${this.options.serverUrl}${uri}`
-    } else {
-      uri = `${this.options.serverUrl}/${uri}`
-    }
-
-    return await corePikkuFetch(uri, data, {
-      ...options,
-      method,
-      mode: this.options.mode,
-      credentials: this.options.credentials,
-      headers: { ...this.getHeaders(), ...options?.headers },
-    })
-  }
-
-  /**
-   * Verifies that the server URL is set before making a request.
-   *
-   * @throws {Error} - Throws an error if the server URL is not set.
-   */
-  private verifyServerUrlSet() {
-    if (!this.options.serverUrl) {
-      throw new Error('Server url is not set')
-    }
-  }
-
-  /**
-   * Transforms date-like strings in the response data into `Date` objects if the `transformDate` option is set.
-   *
-   * @param {any} data - The data to transform.
-   * @returns {any} - The transformed data.
-   */
-  private transformDates(data: any): any {
-    if (!this.options.transformDate) {
-      return data
-    }
-    return transformDates(data)
-  }
-}

package/src/index.ts

@@ -1,15 +0,0 @@
-/**
- * This module provides a wrapper around the Fetch API that integrates with the Pikku framework.
- * It includes utilities for making HTTP requests, such as options for authorization, server URL management,
- * and transforming dates in responses, while ensuring requests are validated against Pikku routes.
- * The module exports the `CorePikkuFetch` class, as well as other supporting types and functions.
- *
- * @module @pikku/fetch
- */
-
-export {
-  CorePikkuFetch,
-  CorePikkuFetchOptions,
-  HTTPMethod,
-} from './abstract-pikku-fetch.js'
-export { corePikkuFetch } from './pikku-fetch.js'

package/src/pikku-fetch.ts

@@ -1,41 +0,0 @@
-/**
- * The `corePikkuFetch` function is a utility for making HTTP requests with dynamic URI and data handling.
- * It can automatically replace URI parameters, append query strings for GET requests, and set the request body for POST, PATCH, or PUT requests.
- *
- * @param {string} uri - The endpoint URI for the request. URI parameters can be specified using `:param` syntax.
- * @param {any} data - The data to be included in the request, either as query parameters or as the request body.
- * @param {Omit<RequestInit, 'body'>} [options] - Optional configuration options for the fetch request, excluding the body.
- * @returns {Promise<Response>} - A promise that resolves to the response of the fetch request.
- */
-export const corePikkuFetch = async (
-  uri: string,
-  data: any,
-  options?: Omit<RequestInit, 'body'>
-) => {
-  const method = options?.method?.toUpperCase() || 'GET'
-  let body: any | undefined
-
-  if (data) {
-    data = JSON.parse(JSON.stringify(data))
-
-    const keys = Object.keys(data)
-    for (const key of keys) {
-      if (uri.includes(`:${key}`)) {
-        uri = uri.replace(`:${key}`, data[key])
-        delete data[key]
-      }
-    }
-    if (method === 'POST' || method === 'PATCH' || method === 'PUT') {
-      body = data
-    } else {
-      const queryString = new URLSearchParams(JSON.parse(JSON.stringify(data)))
-      uri = `${uri}?${queryString}`
-    }
-  }
-
-  return await fetch(uri, {
-    method: method.toUpperCase(),
-    ...options,
-    body: body ? JSON.stringify(body) : undefined,
-  })
-}

package/src/transform-date.ts

@@ -1,26 +0,0 @@
-/**
- * The `transformDates` function recursively traverses an object or array and converts any date-like strings
- * into JavaScript `Date` objects. This helps in ensuring that date fields are properly handled as `Date` instances
- * rather than strings.
- *
- * @private
- * @param {any} data - The input data that may contain date strings. It can be an object, array, or primitive value.
- * @returns {any} - The transformed data with date strings converted to `Date` objects.
- */
-export const transformDates = (data: any) => {
-  if (data === null) return null
-  if (Array.isArray(data)) return data.map(transformDates.bind(this))
-  if (typeof data === 'object') {
-    return Object.entries(data).reduce((result, [key, value]) => {
-      result[key] = transformDates(value)
-      return result
-    }, {} as any)
-  }
-  if (
-    typeof data === 'string' &&
-    /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}\.\d{3}Z?)?/.test(data)
-  ) {
-    return new Date(data)
-  }
-  return data
-}

package/tsconfig.cjs.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "module": "commonjs",
-    "outDir": "dist/cjs",
-    "target": "es2015",
-    "moduleResolution": "node"
-  },
-  "exclude": ["**/*.test.ts", "node_modules", "dist"]
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "module": "Node16",
-    "outDir": "dist/esm",
-    "target": "esnext",
-    "declaration": true,
-    "resolveJsonModule": true,
-    "lib": ["DOM"]
-  },
-  "include": ["src/*.ts"],
-  "exclude": ["**/*.test.ts", "node_modules"]
-}