depreciate Secret module in favour of the Redacted module (#3195)

.changeset/young-knives-poke.md

@@ -0,0 +1,7 @@
+---
+"effect": major
+"@effect/platform-node-shared": minor
+"@effect/cli": minor
+---
+
+depreciate Secret module in favour of the Redacted module

packages/cli/src/Args.ts

@@ -11,7 +11,6 @@ import type { Effect } from "effect/Effect"
 import type { Option } from "effect/Option"
 import type { Pipeable } from "effect/Pipeable"
 import type { Redacted } from "effect/Redacted"
-import type { Secret } from "effect/Secret"
 import type { CliConfig } from "./CliConfig.js"
 import type { HelpDoc } from "./HelpDoc.js"
 import * as InternalArgs from "./internal/args.js"
@@ -387,16 +386,6 @@ export const repeated: <A>(self: Args<A>) => Args<Array<A>> = InternalArgs.repea
  */
 export const redacted: (config?: Args.BaseArgsConfig) => Args<Redacted> = InternalArgs.redacted
 
-/**
- * Creates a text argument.
- *
- * Can optionally provide a custom argument name (defaults to `"secret"`).
- *
- * @since 1.0.0
- * @category constructors
- */
-export const secret: (config?: Args.BaseArgsConfig) => Args<Secret> = InternalArgs.secret
-
 /**
  * Creates a text argument.
  *

packages/cli/src/Options.ts

@@ -13,7 +13,6 @@ import type { HashMap } from "effect/HashMap"
 import type { Option } from "effect/Option"
 import type { Pipeable } from "effect/Pipeable"
 import type { Redacted } from "effect/Redacted"
-import type { Secret } from "effect/Secret"
 import type { CliConfig } from "./CliConfig.js"
 import type { HelpDoc } from "./HelpDoc.js"
 import * as InternalOptions from "./internal/options.js"
@@ -314,13 +313,6 @@ export const none: Options<void> = InternalOptions.none
  */
 export const redacted: (name: string) => Options<Redacted> = InternalOptions.redacted
 
-/**
- * @since 1.0.0
- * @category constructors
- * @deprecated
- */
-export const secret: (name: string) => Options<Secret> = InternalOptions.secret
-
 /**
  * @since 1.0.0
  * @category constructors

packages/cli/src/internal/args.ts

@@ -13,7 +13,6 @@ import * as Option from "effect/Option"
 import { pipeArguments } from "effect/Pipeable"
 import type * as Redacted from "effect/Redacted"
 import * as Ref from "effect/Ref"
-import type * as Secret from "effect/Secret"
 import type * as Args from "../Args.js"
 import type * as CliConfig from "../CliConfig.js"
 import type * as HelpDoc from "../HelpDoc.js"
@@ -272,11 +271,6 @@ export const redacted = (
   config?: Args.Args.BaseArgsConfig
 ): Args.Args<Redacted.Redacted> => makeSingle(Option.fromNullable(config?.name), InternalPrimitive.redacted)
 
-/** @internal */
-export const secret = (
-  config?: Args.Args.BaseArgsConfig
-): Args.Args<Secret.Secret> => makeSingle(Option.fromNullable(config?.name), InternalPrimitive.secret)
-
 /** @internal */
 export const text = (config?: Args.Args.BaseArgsConfig): Args.Args<string> =>
   makeSingle(Option.fromNullable(config?.name), InternalPrimitive.text)

packages/cli/src/internal/options.ts

@@ -15,7 +15,6 @@ import * as Order from "effect/Order"
 import { pipeArguments } from "effect/Pipeable"
 import type * as Redacted from "effect/Redacted"
 import * as Ref from "effect/Ref"
-import type * as Secret from "effect/Secret"
 import type * as CliConfig from "../CliConfig.js"
 import type * as HelpDoc from "../HelpDoc.js"
 import type * as Options from "../Options.js"
@@ -380,10 +379,6 @@ export const none: Options.Options<void> = (() => {
 export const redacted = (name: string): Options.Options<Redacted.Redacted> =>
   makeSingle(name, Arr.empty(), InternalPrimitive.redacted)
 
-/** @internal */
-export const secret = (name: string): Options.Options<Secret.Secret> =>
-  makeSingle(name, Arr.empty(), InternalPrimitive.secret)
-
 /** @internal */
 export const text = (name: string): Options.Options<string> => makeSingle(name, Arr.empty(), InternalPrimitive.text)
 

packages/cli/src/internal/primitive.ts

@@ -6,7 +6,6 @@ import { dual, pipe } from "effect/Function"
 import * as Option from "effect/Option"
 import { pipeArguments } from "effect/Pipeable"
 import * as EffectRedacted from "effect/Redacted"
-import * as EffectSecret from "effect/Secret"
 import type * as CliConfig from "../CliConfig.js"
 import type * as HelpDoc from "../HelpDoc.js"
 import type * as Span from "../HelpDoc/Span.js"
@@ -52,7 +51,6 @@ export type Instruction =
   | Float
   | Integer
   | Path
-  | Secret
   | Redacted
   | Text
 
@@ -90,9 +88,6 @@ export interface Path extends
 /** @internal */
 export interface Redacted extends Op<"Redacted", {}> {}
 
-/** @internal */
-export interface Secret extends Op<"Secret", {}> {}
-
 /** @internal */
 export interface Text extends Op<"Text", {}> {}
 
@@ -125,9 +120,6 @@ export const isIntegerType = (self: Instruction): self is Integer => self._tag =
 /** @internal */
 export const isPathType = (self: Instruction): self is Path => self._tag === "Path"
 
-/** @internal */
-export const isSecretType = (self: Instruction): self is Path => self._tag === "Path"
-
 /** @internal */
 export const isTextType = (self: Instruction): self is Text => self._tag === "Text"
 
@@ -205,13 +197,6 @@ export const redacted: Primitive.Primitive<EffectRedacted.Redacted> = (() => {
   return op
 })()
 
-/** @internal */
-export const secret: Primitive.Primitive<EffectSecret.Secret> = (() => {
-  const op = Object.create(proto)
-  op._tag = "Secret"
-  return op
-})()
-
 /** @internal */
 export const text: Primitive.Primitive<string> = (() => {
   const op = Object.create(proto)
@@ -283,7 +268,6 @@ const getChoicesInternal = (self: Instruction): Option.Option<string> => {
     case "Integer":
     case "Path":
     case "Redacted":
-    case "Secret":
     case "Text": {
       return Option.none()
     }
@@ -346,7 +330,6 @@ const getHelpInternal = (self: Instruction): Span.Span => {
           `('${self.pathType}') and path existence ('${self.pathExists}')`
       )
     }
-    case "Secret":
     case "Redacted": {
       return InternalSpan.text("A user-defined piece of text that is confidential.")
     }
@@ -382,9 +365,6 @@ const getTypeNameInternal = (self: Instruction): string => {
     case "Redacted": {
       return "redacted"
     }
-    case "Secret": {
-      return "secret"
-    }
     case "Text": {
       return "text"
     }
@@ -467,11 +447,6 @@ const validateInternal = (
         Effect.map((value) => EffectRedacted.make(value))
       )
     }
-    case "Secret": {
-      return attempt(value, getTypeNameInternal(self), Schema.decodeUnknown(Schema.String)).pipe(
-        Effect.map((value) => EffectSecret.fromString(value))
-      )
-    }
     case "Text": {
       return attempt(value, getTypeNameInternal(self), Schema.decodeUnknown(Schema.String))
     }
@@ -601,13 +576,6 @@ const wizardInternal = (self: Instruction, help: HelpDoc.HelpDoc): Prompt.Prompt
         message: InternalHelpDoc.toAnsiText(message).trimEnd()
       })
     }
-    case "Secret": {
-      const primitiveHelp = InternalHelpDoc.p("Enter some text (value will be redacted)")
-      const message = InternalHelpDoc.sequence(help, primitiveHelp)
-      return InternalTextPrompt.hidden({
-        message: InternalHelpDoc.toAnsiText(message).trimEnd()
-      })
-    }
     case "Text": {
       const primitiveHelp = InternalHelpDoc.p("Enter some text")
       const message = InternalHelpDoc.sequence(help, primitiveHelp)
@@ -631,7 +599,6 @@ export const getBashCompletions = (self: Instruction): string => {
     case "DateTime":
     case "Float":
     case "Integer":
-    case "Secret":
     case "Redacted":
     case "Text": {
       return "$(compgen -f \"${cur}\")"
@@ -675,7 +642,6 @@ export const getFishCompletions = (self: Instruction): Array<string> => {
     case "Float":
     case "Integer":
     case "Redacted":
-    case "Secret":
     case "Text": {
       return Arr.make("-r", "-f")
     }
@@ -755,7 +721,6 @@ export const getZshCompletions = (self: Instruction): string => {
       }
     }
     case "Redacted":
-    case "Secret":
     case "Text": {
       return ""
     }

packages/effect/src/Config.ts

@@ -14,7 +14,6 @@ import type * as LogLevel from "./LogLevel.js"
 import type * as Option from "./Option.js"
 import type { Predicate, Refinement } from "./Predicate.js"
 import type * as Redacted from "./Redacted.js"
-import type * as Secret from "./Secret.js"
 import type * as Types from "./Types.js"
 
 /**
@@ -334,15 +333,6 @@ export const primitive: <A>(
  */
 export const repeat: <A>(self: Config<A>) => Config<Array<A>> = internal.repeat
 
-/**
- * Constructs a config for a secret value.
- *
- * @since 2.0.0
- * @category constructors
- * @deprecated
- */
-export const secret: (name?: string) => Config<Secret.Secret> = internal.secret
-
 /**
  * Constructs a config for a redacted value.
  *

packages/effect/src/index.ts

@@ -729,12 +729,6 @@ export * as ScopedCache from "./ScopedCache.js"
  */
 export * as ScopedRef from "./ScopedRef.js"
 
-/**
- * @since 2.0.0
- * @deprecated
- */
-export * as Secret from "./Secret.js"
-
 /**
  * @since 2.0.0
  */

packages/effect/src/internal/config.ts

@@ -11,14 +11,12 @@ import type * as LogLevel from "../LogLevel.js"
 import * as Option from "../Option.js"
 import { hasProperty, type Predicate, type Refinement } from "../Predicate.js"
 import type * as Redacted from "../Redacted.js"
-import type * as Secret from "../Secret.js"
 import * as configError from "./configError.js"
 import * as core from "./core.js"
 import * as defaultServices from "./defaultServices.js"
 import * as effectable from "./effectable.js"
 import * as OpCodes from "./opCodes/config.js"
 import * as redacted_ from "./redacted.js"
-import * as InternalSecret from "./secret.js"
 
 const ConfigSymbolKey = "effect/Config"
 
@@ -414,15 +412,6 @@ export const repeat = <A>(self: Config.Config<A>): Config.Config<Array<A>> => {
   return repeat
 }
 
-/** @internal */
-export const secret = (name?: string): Config.Config<Secret.Secret> => {
-  const config = primitive(
-    "a secret property",
-    (text) => Either.right(InternalSecret.fromString(text))
-  )
-  return name === undefined ? config : nested(config, name)
-}
-
 /** @internal */
 export const redacted = (name?: string): Config.Config<Redacted.Redacted> => {
   const config = primitive(