Rename ConfigSecret to Secret (#1745)

.changeset/weak-tables-love.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+rename ConfigSecret to Secret

src/Config.ts

@@ -3,7 +3,6 @@
  */
 import type * as Chunk from "./Chunk.js"
 import type * as ConfigError from "./ConfigError.js"
-import type * as ConfigSecret from "./ConfigSecret.js"
 import type * as Either from "./Either.js"
 import type { LazyArg } from "./Function.js"
 import type * as HashMap from "./HashMap.js"
@@ -13,6 +12,7 @@ import type * as LogLevel from "./LogLevel.js"
 import type * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
 import type { Predicate, Refinement } from "./Predicate.js"
+import type * as Secret from "./Secret.js"
 import type * as Types from "./Types.js"
 
 /**
@@ -300,7 +300,7 @@ export const repeat: <A>(self: Config<A>) => Config<Array<A>> = internal.repeat
  * @since 2.0.0
  * @category constructors
  */
-export const secret: (name?: string) => Config<ConfigSecret.ConfigSecret> = internal.secret
+export const secret: (name?: string) => Config<Secret.Secret> = internal.secret
 
 /**
  * Constructs a config for a sequence of values.

src/Secret.ts

@@ -0,0 +1,75 @@
+/**
+ * @since 2.0.0
+ */
+import type * as Equal from "./Equal.js"
+import * as InternalSecret from "./internal/secret.js"
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const SecretTypeId: unique symbol = InternalSecret.SecretTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type SecretTypeId = typeof SecretTypeId
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface Secret extends Secret.Proto, Equal.Equal {
+  /** @internal */
+  readonly raw: Array<number>
+}
+
+/**
+ * @since 2.0.0
+ */
+export declare namespace Secret {
+  /**
+   * @since 2.0.0
+   * @category models
+   */
+  export interface Proto {
+    readonly [SecretTypeId]: SecretTypeId
+  }
+}
+
+/**
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isSecret: (u: unknown) => u is Secret = InternalSecret.isSecret
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const make: (bytes: Array<number>) => Secret = InternalSecret.make
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const fromIterable: (iterable: Iterable<string>) => Secret = InternalSecret.fromIterable
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+export const fromString: (text: string) => Secret = InternalSecret.fromString
+
+/**
+ * @since 2.0.0
+ * @category getters
+ */
+export const value: (self: Secret) => string = InternalSecret.value
+
+/**
+ * @since 2.0.0
+ * @category unsafe
+ */
+export const unsafeWipe: (self: Secret) => void = InternalSecret.unsafeWipe

src/index.ts

@@ -154,11 +154,6 @@ export * as ConfigProvider from "./ConfigProvider.js"
  */
 export * as ConfigProviderPathPatch from "./ConfigProviderPathPatch.js"
 
-/**
- * @since 2.0.0
- */
-export * as ConfigSecret from "./ConfigSecret.js"
-
 /**
  * @since 2.0.0
  */
@@ -643,6 +638,11 @@ export * as ScopedCache from "./ScopedCache.js"
  */
 export * as ScopedRef from "./ScopedRef.js"
 
+/**
+ * @since 2.0.0
+ */
+export * as Secret from "./Secret.js"
+
 /**
  * @since 2.0.0
  */

src/internal/config.ts

@@ -1,7 +1,6 @@
 import * as Chunk from "../Chunk.js"
 import type * as Config from "../Config.js"
 import * as ConfigError from "../ConfigError.js"
-import type * as ConfigSecret from "../ConfigSecret.js"
 import * as Either from "../Either.js"
 import type { LazyArg } from "../Function.js"
 import { constTrue, dual, pipe } from "../Function.js"
@@ -11,10 +10,11 @@ import type * as LogLevel from "../LogLevel.js"
 import * as Option from "../Option.js"
 import { pipeArguments } from "../Pipeable.js"
 import { hasProperty, type Predicate, type Refinement } from "../Predicate.js"
+import type * as Secret from "../Secret.js"
 import * as configError from "./configError.js"
-import * as configSecret from "./configSecret.js"
 import * as core from "./core.js"
 import * as OpCodes from "./opCodes/config.js"
+import * as InternalSecret from "./secret.js"
 
 const ConfigSymbolKey = "effect/Config"
 
@@ -380,10 +380,10 @@ export const repeat = <A>(self: Config.Config<A>): Config.Config<Array<A>> => {
 }
 
 /** @internal */
-export const secret = (name?: string): Config.Config<ConfigSecret.ConfigSecret> => {
+export const secret = (name?: string): Config.Config<Secret.Secret> => {
   const config = primitive(
     "a secret property",
-    (text) => Either.right(configSecret.fromString(text))
+    (text) => Either.right(InternalSecret.fromString(text))
   )
   return name === undefined ? config : nested(config, name)
 }

src/internal/secret.ts

@@ -0,0 +1,69 @@
+import * as Equal from "../Equal.js"
+import { pipe } from "../Function.js"
+import * as Hash from "../Hash.js"
+import { hasProperty } from "../Predicate.js"
+import * as ReadonlyArray from "../ReadonlyArray.js"
+import type * as Secret from "../Secret.js"
+
+/** @internal */
+const SecretSymbolKey = "effect/Secret"
+
+/** @internal */
+export const SecretTypeId: Secret.SecretTypeId = Symbol.for(
+  SecretSymbolKey
+) as Secret.SecretTypeId
+
+/** @internal */
+export const proto = {
+  [SecretTypeId]: SecretTypeId,
+  [Hash.symbol](this: Secret.Secret): number {
+    return pipe(
+      Hash.hash(SecretSymbolKey),
+      Hash.combine(Hash.array(this.raw))
+    )
+  },
+  [Equal.symbol](this: Secret.Secret, that: unknown): boolean {
+    return isSecret(that) && this.raw.length === that.raw.length &&
+      this.raw.every((v, i) => Equal.equals(v, that.raw[i]))
+  }
+}
+
+/** @internal */
+export const isSecret = (u: unknown): u is Secret.Secret => hasProperty(u, SecretTypeId)
+
+/** @internal */
+export const make = (bytes: Array<number>): Secret.Secret => {
+  const secret = Object.create(proto)
+  Object.defineProperty(secret, "toString", {
+    enumerable: false,
+    value() {
+      return "Secret(<redacted>)"
+    }
+  })
+  Object.defineProperty(secret, "raw", {
+    enumerable: false,
+    value: bytes
+  })
+  return secret
+}
+
+/** @internal */
+export const fromIterable = (iterable: Iterable<string>): Secret.Secret =>
+  make(ReadonlyArray.fromIterable(iterable).map((char) => char.charCodeAt(0)))
+
+/** @internal */
+export const fromString = (text: string): Secret.Secret => {
+  return make(text.split("").map((char) => char.charCodeAt(0)))
+}
+
+/** @internal */
+export const value = (self: Secret.Secret): string => {
+  return self.raw.map((byte) => String.fromCharCode(byte)).join("")
+}
+
+/** @internal */
+export const unsafeWipe = (self: Secret.Secret): void => {
+  for (let i = 0; i < self.raw.length; i++) {
+    self.raw[i] = 0
+  }
+}