Function prefixedStringId

packages/effect-app/src/Schema/moreStrings.ts:221–273

()

 * note.
 */
export function prefixedStringId<Type extends StringId>() {
  return <Prefix extends string, Separator extends string = "-">(
    prefix: Prefix,
    name: string,
    separator?: Separator
  ) => {
    type FullPrefix = `${Prefix}${Separator}`
    const pref = `${prefix}${separator ?? "-"}` as FullPrefix
    const arb = (): S.Arbitrary<Type> => (fc) =>
      StringIdArb()(fc).map(
        (x) => (pref + x.substring(0, 50 - pref.length)) as Type
      )
    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
    const s = StringIdSchemaBase
      .pipe(
        S.refine((x: string): x is Type => x.startsWith(pref), {
          identifier: name
        }),
        S.annotate({
          toArbitrary: () => (fc) => arb()(fc)
        })
      )
    const schema = s.pipe(withDefaultMake)
    const make = () => (pref + StringId.make().substring(0, 50 - pref.length)) as Type

    return extendM(
      schema,
      (ex): PrefixedStringUtils<Type, Prefix, Separator> => ({
        make,
        /**
         * Automatically adds the prefix.
         */
        unsafeFrom: (str: string) => ex(pref + str),
        /**
         * Must provide a literal string starting with prefix.
         */
        prefixSafe: <REST extends string>(str: `${Prefix}${Separator}${REST}`) => ex(str),
        prefix,
        /**
         * Construction-only default: fresh prefixed id. Applied only when
         * the field is omitted from `.make(...)` input. NOT applied during
         * decode — cannot be used to JIT-migrate database fields. See
         * file-level note.
         */
        withConstructorDefault: schema.pipe(
          S.withConstructorDefault<S.Codec<Type, string> & S.WithoutConstructorDefault>(
            Effect.sync(make)
          )
        )
      })
    )
  }
}

/**
 * Build a branded `StringId` schema for the given branded `Id` type.