fix build

Author: ymc9

versioned_docs/version-3.x/reference/runtime-api.md

@@ -6,125 +6,3 @@ sidebar_label: Runtime API
 
 # Runtime API Reference
 
-This document provides references for runtime APIs exported from the `@zenstackhq/runtime` package.
-
-### enhance
-
-#### Description
-
-Creates an enhanced wrapper for a `PrismaClient`. The return value has the same APIs as the original `PrismaClient`.
-
-#### Signature
-
-```ts
-function enhance<DbClient extends object>(
-    prisma: DbClient,
-    context?: EnhancementContext,
-    options?: EnhancementOptions
-): DbClient;
-```
-
-##### Parameter `prisma`
-
-The PrismaClient instance to enhance.
-
-##### Parameter `context`
-
-The context to for evaluating access policies with the following typing.
-
-```ts
-type EnhancementContext = {
-    user?: Record<string, unknown>
-};
-```
-
-| Field | Description |
-| ----- | ----------- |
-| user  | The user object that provides value for the `auth()` function call in access policies. If provided. Its shape should be consistent with the `User` model in your ZModel, with all fields optional except for id field(s). Pass `undefined` to represent an anonymous user, and the `auth()` function call will evaluate to `null` in that case. |
-
-##### Parameter `options`
-
-Options with the following typing.
-
-```ts
-type TransactionIsolationLevel =
-    | 'ReadUncommitted'
-    | 'ReadCommitted'
-    | 'RepeatableRead'
-    | 'Snapshot'
-    | 'Serializable';
-
-type SimpleEncryption = {
-    encryptionKey: Uint8Array;
-    decryptionKeys?: Uint8Array[];
-}
-
-type CustomEncryption = {
-    encrypt: (model: string, field: FieldInfo, plain: string) => Promise<string>;
-    decrypt: (model: string, field: FieldInfo, cipher: string) => Promise<string>;
-};
-
-type ValidationOptions = {
-    inputOnlyValidationForUpdate?: boolean;
-};
-
-type EnhancementOptions = {
-    kinds?: EnhancementKind[];
-    logPrismaQuery?: boolean;
-    errorTransformer?: ErrorTransformer;
-    transactionMaxWait?: number;
-    transactionTimeout?: number;
-    transactionIsolationLevel?: TransactionIsolationLevel;
-    encryption?: SimpleEncryption | CustomEncryption;
-    validation?: ValidationOptions;
-};
-```
-
-| Field                     | Description                                                                                      | Default                                                                         |
-| ------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
-| kinds                     | The kinds of enhancements to apply. By default all enhancements are applied. See [the next section](#enhancement-kinds) for more details. | All enhancement kinds                                                          |
-| logPrismaQuery            | Whether to log queries sent to Prisma client. Log will be emitted with "info" level, so please make sure you [turn that level on](https://www.prisma.io/docs/concepts/components/prisma-client/working-with-prismaclient/logging#log-to-stdout) when creating Prisma client | false                        |
-| errorTransformer          | A function for transforming error thrown by the enhanced `PrismaClient` into a custom one. |                         |
-| transactionMaxWait        | The `maxWait` option (in ms) passed to `prisma.$transaction()` call for transactions initiated by ZenStack. |  Database default                       |
-| transactionTimeout        | The `timeout` option (in ms) passed to `prisma.$transaction()` call for transactions initiated by ZenStack. |  Database default                       |
-| transactionIsolationLevel | The `isolationLevel` option passed to `prisma.$transaction()` call for transactions initiated by ZenStack. |  Database default                       |
-| encryption | Field encryption settings. Only required when using the [field encryption](../guides/field-encryption.md) feature. |                         |
-| validation.inputOnlyValidationForUpdate | By default, ZenStack validates an entity after "update" operation to ensure the final result satisfies validation rules as a whole. This implies if the record under update doesn't satisfy the rules prior to update, the update operation will fail even if the fields causing validation errors are not affected by the operation. You can set this option to `true` to let ZenStack only validate data contained in the input args. | false |
-
-#### Enhancement Kinds
-
-Here are the kinds of enhancements available:
-
-- `policy`
-  
-    Enforces model-level and field-level access policies defined with `@@allow`, `@@deny`, `@allow`, and `@deny`.
-
-- `validation`
-  
-    Validates create and update input data against rules defined with [data validation attributes](../reference/zmodel-language#data-validation).
-  
-- `delegate`
-  
-    Support for modeling [polymorphic relations](../guides/polymorphism) with delegated types pattern.
-  
-- `password`
-  
-    Automatically hashes fields marked with the `@password` attribute using `bcryptjs` before saving to the database.
-  
-- `omit`
-
-    Automatically omits fields marked with the `@omit` attribute from read results.
-
-- `encryption`
-
-    Transparently encrypt and decrypt fields marked with the `@encrypted` attribute. See [this guide](../guides/field-encryption.md) for more details.
-
-#### Example
-
-```ts
-const session = getSession();
-const enhancedClient = enhance(prisma,
-  { user: session.user },
-  { kinds: ['policy', 'password']}
-);
-```