Merge pull request #150 from supercharge/remove-deprecated-contracts

Align and Remove deprecated contracts

Author: marcuspoehls

CHANGELOG.md

@@ -17,6 +17,14 @@
 - `@supercharge/contracts`
     - `StateBag`: add `exists` method to determine whether the state bag contains an entry `key`, no matter what value is assigned to the key
 
+### Removed
+- `@supercharge/contracts`
+    - removed `BodyparserOptions`: use `BodyparserConfig` instead
+    - removed `CookieOptions`: use `CookieConfig` instead
+    - removed `CorsOptions`: use `CorsConfig` instead
+    - removed `HashBuilderOptions`: use `HashBuilderConfig` instead
+    - removed `StaticAssetsOptions`: use `StaticAssetsConfig` instead
+
 ### Breaking Changes
 - all packages of the framework moved to ESM
 - require Node.js v20

packages/contracts/src/hashing/hash-builder.ts

@@ -3,7 +3,7 @@ import type { BinaryToTextEncoding, Encoding } from 'node:crypto'
 
 export type HashBuilderCallback = (hashBuilder: HashBuilder) => unknown
 
-export interface HashBuilderOptions {
+export interface HashBuilderConfig {
   inputEncoding?: Encoding
   outputEncoding: BinaryToTextEncoding
 }

packages/contracts/src/http/bodyparser-config.ts

@@ -1,13 +1,6 @@
 
 import { HttpMethods } from './methods.js'
 
-/**
- * @deprecated The `BodyparserOptions` is deprecated in favor of the `BodyparserConfig`
- * interface. We’ll remove the `BodyparserOptions` interface in the upcoming release
- * of the Supercharge framework. You might switch already to the renamed interface.
- */
-export type BodyparserOptions = BodyparserConfig
-
 export interface BodyparserConfig {
   /**
    * --------------------------------------------------------------------------

packages/contracts/src/http/config.ts

@@ -1,5 +1,5 @@
 
-import { CookieOptions } from './cookie-options.js'
+import { CookieConfig } from './cookie-config.js'
 
 export interface HttpConfig {
   /**
@@ -15,5 +15,5 @@ export interface HttpConfig {
   /**
    * The HTTP cookie options.
    */
-  cookie: CookieOptions
+  cookie: CookieConfig
 }

packages/contracts/src/http/cookie-bag.ts

@@ -1,5 +1,5 @@
 
-import { RequestCookieBuilderCallback, ResponseCookieBuilderCallback } from './cookie-options-builder.js'
+import { RequestCookieBuilderCallback, ResponseCookieBuilderCallback } from './cookie-config-builder.js'
 
 export interface CookieBag {
   /**

packages/contracts/src/http/cookie-options-builder.ts renamed to packages/contracts/src/http/cookie-config-builder.ts

@@ -1,5 +1,5 @@
 
-import { CookieOptions } from './cookie-options.js'
+import { CookieConfig } from './cookie-config.js'
 
 export type RequestCookieBuilderCallback = (cookieBuilder: RequestCookieBuilder) => void
 export type ResponseCookieBuilderCallback = (cookieBuilder: ResponseCookieBuilder) => void
@@ -71,5 +71,5 @@ export interface ResponseCookieBuilder {
   /**
    * Merge the given `config` with the default HTTP cookie config.
    */
-  useConfig (config: Partial<CookieOptions>): this
+  useConfig (config: Partial<CookieConfig>): this
 }

packages/contracts/src/http/cookie-options.ts renamed to packages/contracts/src/http/cookie-config.ts

@@ -1,5 +1,5 @@
 
-export interface CookieOptions {
+export interface CookieConfig {
   /**
    * The time or date in the future at which the cookie expires.
    */

packages/contracts/src/http/cors-config.ts

@@ -1,11 +1,4 @@
 
-/**
- * @deprecated The `CorsOptions` is deprecated in favor of the `CorsConfig`
- * interface. We’ll remove the `CorsOptions` interface in the upcoming
- * release of the Supercharge framework. You may already switch to the renamed interface.
- */
-export type CorsOptions = CorsConfig
-
 export interface CorsConfig {
   /**
    * Controls the `Access-Control-Max-Age` header in seconds.

packages/contracts/src/http/request.ts

@@ -6,18 +6,18 @@ import { HttpContext } from './context.js'
 import { CookieBag } from './cookie-bag.js'
 import { IncomingMessage } from 'node:http'
 import { IncomingHttpHeaders } from 'node:http2'
-import { CookieOptions } from './cookie-options.js'
+import { CookieConfig } from './cookie-config.js'
 import { MacroableCtor } from '@supercharge/macroable'
 import { QueryParameterBag } from './query-parameter-bag.js'
 import { InteractsWithState } from './concerns/interacts-with-state.js'
-import { RequestCookieBuilderCallback } from './cookie-options-builder.js'
+import { RequestCookieBuilderCallback } from './cookie-config-builder.js'
 import { InteractsWithContentTypes } from './concerns/interacts-with-content-types.js'
 
 export interface HttpRequestCtor extends MacroableCtor {
   /**
    * Create a new HTTP request instance.
    */
-  new (context: HttpContext, cookieOptions: CookieOptions): HttpRequest
+  new (context: HttpContext, cookieConfig: CookieConfig): HttpRequest
 }
 
 export type Protocol = 'http' | 'https' | string

packages/contracts/src/http/response.ts

@@ -4,16 +4,16 @@ import { HttpContext } from './context.js'
 import { CookieBag } from './cookie-bag.js'
 import { OutgoingHttpHeaders } from 'http2'
 import { HttpRedirect } from './redirect.js'
-import { CookieOptions } from './cookie-options.js'
+import { CookieConfig } from './cookie-config.js'
 import { MacroableCtor } from '@supercharge/macroable'
 import { InteractsWithState } from './concerns/interacts-with-state.js'
-import { ResponseCookieBuilderCallback } from './cookie-options-builder.js'
+import { ResponseCookieBuilderCallback } from './cookie-config-builder.js'
 
 export interface HttpResponseCtor extends MacroableCtor {
   /**
    * Create a new HTTP response instance.
    */
-  new (context: HttpContext, cookieOptions: CookieOptions): HttpResponse
+  new (context: HttpContext, cookieConfig: CookieConfig): HttpResponse
 }
 
 export interface HttpResponse<T = any> extends InteractsWithState {

packages/contracts/src/http/static-assets-config.ts

@@ -1,11 +1,4 @@
 
-/**
- * @deprecated The `StaticAssetsOptions` is deprecated in favor of the `StaticAssetsConfig`
- * interface. We’ll remove the `StaticAssetsOptions` interface in the upcoming release
- * of the Supercharge framework. You might switch already to the renamed interface.
- */
-export type StaticAssetsOptions = StaticAssetsConfig
-
 export interface StaticAssetsConfig {
   /**
    * Define the maximum amount of seconds to cache a static resource

packages/contracts/src/index.ts

@@ -20,19 +20,19 @@ export { EnvStore } from './env/env.js'
 export { Bootstrapper, BootstrapperCtor } from './core/bootstrapper.js'
 export { ErrorHandler, ErrorHandlerCtor } from './core/error-handler.js'
 
-export { HashBuilder, HashBuilderCallback, HashBuilderOptions } from './hashing/hash-builder.js'
+export { HashBuilder, HashBuilderCallback, HashBuilderConfig } from './hashing/hash-builder.js'
 export { HashConfig } from './hashing/config.js'
 export { BaseHasher } from './hashing/base-hasher.js'
 export { Hasher } from './hashing/hasher.js'
 
-export { BodyparserConfig, BodyparserOptions } from './http/bodyparser-config.js'
+export { BodyparserConfig } from './http/bodyparser-config.js'
 export { HttpConfig } from './http/config.js'
 export { HttpContext, NextHandler } from './http/context.js'
 export { HttpController } from './http/controller.js'
 export { CookieBag } from './http/cookie-bag.js'
-export { CookieOptions } from './http/cookie-options.js'
-export { RequestCookieBuilder, RequestCookieBuilderCallback, ResponseCookieBuilder, ResponseCookieBuilderCallback } from './http/cookie-options-builder.js'
-export { CorsConfig, CorsOptions } from './http/cors-config.js'
+export { CookieConfig } from './http/cookie-config.js'
+export { RequestCookieBuilder, RequestCookieBuilderCallback, ResponseCookieBuilder, ResponseCookieBuilderCallback } from './http/cookie-config-builder.js'
+export { CorsConfig } from './http/cors-config.js'
 export { InteractsWithContentTypes } from './http/concerns/interacts-with-content-types.js'
 export { InteractsWithState } from './http/concerns/interacts-with-state.js'
 export { StateBag, HttpStateData } from './http/concerns/state-bag.js'
@@ -52,7 +52,7 @@ export { HttpRouteGroup } from './http/route-group.js'
 export { HttpRoute, RouteObjectAttributes } from './http/route.js'
 export { HttpRouter, RouteHandler, RouteAttributes } from './http/router.js'
 export { HttpServer, HttpServerHandler } from './http/server.js'
-export { StaticAssetsConfig, StaticAssetsOptions } from './http/static-assets-config.js'
+export { StaticAssetsConfig } from './http/static-assets-config.js'
 export { UploadedFile } from './http/uploaded-file.js'
 
 export { LoggingConfig, LogChannelConfig, LoggingChannels, ConsoleChannelConfig, FileChannelConfig } from './logging/config.js'

packages/hashing/src/base-hasher.ts

@@ -1,7 +1,7 @@
 
 import { HashBuilder } from './hash-builder.js'
 import Crypto, { BinaryLike, Encoding, Hash } from 'node:crypto'
-import { BaseHasher as BaseHasherContract, HashBuilderCallback, HashBuilderOptions } from '@supercharge/contracts'
+import { BaseHasher as BaseHasherContract, HashBuilderCallback, HashBuilderConfig } from '@supercharge/contracts'
 
 export class BaseHasher implements BaseHasherContract {
   /**
@@ -56,13 +56,13 @@ export class BaseHasher implements BaseHasherContract {
     }
 
     if (typeof inputEncodingOrHashBuilder === 'function') {
-      const hashBuilderOptions: HashBuilderOptions = { outputEncoding: 'base64' }
-      const builder = new HashBuilder(hashBuilderOptions)
+      const hashBuilderConfig: HashBuilderConfig = { outputEncoding: 'base64' }
+      const builder = new HashBuilder(hashBuilderConfig)
       inputEncodingOrHashBuilder(builder)
 
       return this
-        .createHash(algorithm, input, hashBuilderOptions.inputEncoding)
-        .digest(hashBuilderOptions.outputEncoding)
+        .createHash(algorithm, input, hashBuilderConfig.inputEncoding)
+        .digest(hashBuilderConfig.outputEncoding)
     }
 
     return this

packages/hashing/src/hash-builder.ts

@@ -1,26 +1,38 @@
 
-import { HashBuilder as HashBuilderContract, HashBuilderOptions } from '@supercharge/contracts'
-import { BinaryToTextEncoding, Encoding } from 'crypto'
+import { BinaryToTextEncoding, Encoding } from 'node:crypto'
+import { HashBuilder as HashBuilderContract, HashBuilderConfig } from '@supercharge/contracts'
 
 export class HashBuilder implements HashBuilderContract {
   /**
-   * Stores the hash builder options.
+   * Stores the hash builder config.
    */
-  private readonly options: HashBuilderOptions
+  private readonly config: HashBuilderConfig
 
-  constructor (options: HashBuilderOptions) {
-    this.options = options
+  /**
+   * Create a new instance.
+   */
+  constructor (options: HashBuilderConfig) {
+    this.config = options
   }
 
+  /**
+   * Set the input encoding for the related value.
+   */
   inputEncoding (inputEncoding: Encoding): this {
-    this.options.inputEncoding = inputEncoding
+    this.config.inputEncoding = inputEncoding
     return this
   }
 
+  /**
+   * Calculate the final hash string value.
+   */
   digest (encoding: BinaryToTextEncoding): void {
-    this.options.outputEncoding = encoding
+    this.config.outputEncoding = encoding
   }
 
+  /**
+   * This is an alias for the `digest` method that calculates the final hash string.
+   */
   toString (encoding: BinaryToTextEncoding): void {
     this.digest(encoding)
   }

packages/http/src/server/cookie-bag.ts

@@ -3,7 +3,7 @@ import Cookie from 'cookie'
 import * as Cookies from 'cookies'
 import { tap } from '@supercharge/goodies'
 import { RequestCookieBuilder, ResponseCookieBuilder } from './cookies/index.js'
-import { CookieBag as CookieBagContract, CookieOptions, RequestCookieBuilderCallback, ResponseCookieBuilderCallback } from '@supercharge/contracts'
+import { CookieBag as CookieBagContract, CookieConfig, RequestCookieBuilderCallback, ResponseCookieBuilderCallback } from '@supercharge/contracts'
 
 export class CookieBag implements CookieBagContract {
   /**
@@ -14,12 +14,12 @@ export class CookieBag implements CookieBagContract {
   /**
    * Stores the default cookie options.
    */
-  private readonly options: CookieOptions & { signed: boolean }
+  private readonly options: CookieConfig & { signed: boolean }
 
   /**
    * Create a new instance.
    */
-  constructor (cookies: Cookies, options?: CookieOptions) {
+  constructor (cookies: Cookies, options?: CookieConfig) {
     this.cookies = cookies
     this.options = { signed: true, ...options }
   }

packages/http/src/server/cookies/request-cookie-builder.ts

@@ -1,26 +1,26 @@
 
 import { tap } from '@supercharge/goodies'
-import { CookieOptions, RequestCookieBuilder as RequestCookieContract } from '@supercharge/contracts'
+import { CookieConfig, RequestCookieBuilder as RequestCookieContract } from '@supercharge/contracts'
 
 export class RequestCookieBuilder implements RequestCookieContract {
   /**
    * Stores the options used when retrieving a cookie value from the request.
    */
-  private readonly cookieOptions: CookieOptions
+  private readonly cookieConfig: CookieConfig
 
   /**
    * Create a new instance.
    */
-  constructor (options: CookieOptions) {
-    this.cookieOptions = options
+  constructor (options: CookieConfig) {
+    this.cookieConfig = options
   }
 
   /**
    * Retrieve the unsigned cookie value.
    */
   unsigned (): this {
     return tap(this, () => {
-      this.cookieOptions.signed = false
+      this.cookieConfig.signed = false
     })
   }
 }