Skip to content

docs: add Encryption SDK API reference page #8

@coderdan

Description

@coderdan

Summary

The old docs had reference/protect-js — a TypeDoc-style API surface for the SDK formerly known as Protect.js, now the CipherStash Encryption SDK. The new docs reference/ directory has guides (eql-guide, planning-guide, etc.) and operational refs (proxy-reference, error-handling) but no SDK API reference.

What the old page covered

  • Entry-point function reference (protect(), csTable, csColumn, ProtectClientConfig, ProtectClient)

  • Supported data types matrix (string, number, json, bigint, boolean, date — with availability column)

  • Type-casting via dataType() on column definitions, and why it's required for non-string types

  • Special-value handling table:

    Data type Plaintext Encryption
    any null null
    any undefined undefined
    number -0.0 encryption of 0.0
    number NaN error
    number Infinity / -Infinity error
  • Cross-links to the per-database adapter packages

What's currently in the new docs

The interface is shown in usage context across cipherstash/encryption/*.mdx, but there's no single page a user can reach for "what's the full surface of this SDK and how do I configure it".

Suggested page

content/stack/reference/encryption-sdk.mdx (or protect-sdk.mdx) — tables of:

  • Public functions/types
  • Supported data types and casting requirements
  • Special-value semantics
  • ProtectClientConfig options
  • Adapter package list (Drizzle, DynamoDB, Supabase) with cross-links

The TypeDoc output in the SDK repo can drive the bulk of this — old docs used a doc-reference Markdoc tag to embed it; consider either porting that or generating static MDX from typedoc-plugin-markdown.

Reference material

Old page in cipherstash-js-suite git history at apps/docs/src/app/(articles)/reference/protect-js/page.md (commit 1c3d40ed^).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions