Skip to content

Align prisma-next EQL v3 authoring API with the types.* catalog (drop Encrypted prefix) #717

Description

@coderdan

Summary

The @cipherstash/prisma-next EQL v3 authoring surface is out of step with the stack / Drizzle types.* catalog. The cipherstash. namespace already disambiguates, so the redundant Encrypted/encrypted prefixes on the v3 constructors and factories are noise, and the v3 setup function carries a V3 suffix even though v3 is the default.

Desired API

  • PSL column constructors drop Encryptedcipherstash.EncryptedTextSearch()cipherstash.TextSearch(), EncryptedDoubleOrd()DoubleOrd(), EncryptedBoolean()Boolean(), EncryptedJson()Json(), etc.
  • cipherstashFromStackV3cipherstashFromStack (v3 is the default); the v2 setup fn becomes cipherstashFromStackV2.
  • camelCase TS-authoring exports drop encrypted in lockstep — encryptedTextSearchtextSearch, encryptedDoubleOrddoubleOrd, etc. The *V2 factories keep their names.

Deliberately unchanged

  • Runtime value envelopes (EncryptedString/EncryptedNumber/…) — a separate write-side surface.
  • The cipherstash.*V2 legacy constructors and encrypted*V2 factories.
  • Generated contract.json + codec ids (they key off codec ids, not constructor names — no regeneration needed).
  • The eql* query operators.
  • Namespace stays cipherstash (the extension's vendor identity), not eql.

Resolution

Done in #685 — rename applied at the single derivation seam (contract-authoring.ts v3PascalName/v3CamelName), with docs/README/skill updated. Breaking change under rc convention. Follows up on the #683 review.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions