Skip to content

@nestarc/data-subject API reference ​

Register DataSubjectModule with shared policy definitions, then use DataSubjectService for tenant-scoped export, signed previews, and verified erasure. Includes durable execution and recovery, paged jobs, the Transcend adapter, storage contracts, lifecycle events, and error types.

Browse all @nestarc/data-subject import paths.

Classes ​

DataSubjectError ​

Defined in: src/errors.ts:49

Extends ​

  • Error

Extended by ​

Constructors ​

Constructor ​
ts
new DataSubjectError(code, reason?): DataSubjectError;

Defined in: src/errors.ts:53

Parameters ​
ParameterType
codeDataSubjectErrorCode
reason?string
Returns ​

DataSubjectError

Overrides ​
ts
Error.constructor

Properties ​

cause? ​
ts
optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​
ts
Error.cause

code ​
ts
readonly code: DataSubjectErrorCode;

Defined in: src/errors.ts:50

httpStatus ​
ts
readonly httpStatus: number;

Defined in: src/errors.ts:51

message ​
ts
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from ​
ts
Error.message

name ​
ts
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​
ts
Error.name

stack? ​
ts
optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​
ts
Error.stack

stackTraceLimit ​
ts
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​
ts
Error.stackTraceLimit

Methods ​

captureStackTrace() ​
ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters ​
ParameterType
targetObjectobject
constructorOpt?Function
Returns ​

void

Inherited from ​
ts
Error.captureStackTrace

prepareStackTrace() ​
ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters ​
ParameterType
errError
stackTracesCallSite[]
Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​
ts
Error.prepareStackTrace

DataSubjectModule ​

Defined in: src/data-subject.module.ts:31

Constructors ​

Constructor ​
ts
new DataSubjectModule(): DataSubjectModule;
Returns ​

DataSubjectModule

Methods ​

forRoot() ​
ts
static forRoot(options): DynamicModule;

Defined in: src/data-subject.module.ts:32

Parameters ​
ParameterType
optionsDataSubjectModuleOptions
Returns ​

DynamicModule


DataSubjectPersistenceError ​

Defined in: src/errors.ts:62

An indeterminate storage failure: reconcile this ID before executing again.

Extends ​

Constructors ​

Constructor ​
ts
new DataSubjectPersistenceError(
   requestId,
   tenantId,
   dataOutcome): DataSubjectPersistenceError;

Defined in: src/errors.ts:65

Parameters ​
ParameterType
requestIdstring
tenantIdstring
dataOutcome"completed" | "not_started" | "unknown"
Returns ​

DataSubjectPersistenceError

Overrides ​

DataSubjectError.constructor

Properties ​

cause? ​
ts
optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​

DataSubjectError.cause

code ​
ts
readonly code: DataSubjectErrorCode;

Defined in: src/errors.ts:50

Inherited from ​

DataSubjectError.code

dataOutcome ​
ts
readonly dataOutcome: "completed" | "not_started" | "unknown";

Defined in: src/errors.ts:68

httpStatus ​
ts
readonly httpStatus: number;

Defined in: src/errors.ts:51

Inherited from ​

DataSubjectError.httpStatus

message ​
ts
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from ​

DataSubjectError.message

name ​
ts
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

DataSubjectError.name

recovery ​
ts
readonly recovery: "reconcile_request";

Defined in: src/errors.ts:63

requestId ​
ts
readonly requestId: string;

Defined in: src/errors.ts:66

stack? ​
ts
optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​

DataSubjectError.stack

stackTraceLimit ​
ts
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​

DataSubjectError.stackTraceLimit

tenantId ​
ts
readonly tenantId: string;

Defined in: src/errors.ts:67

Methods ​

captureStackTrace() ​
ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters ​
ParameterType
targetObjectobject
constructorOpt?Function
Returns ​

void

Inherited from ​

DataSubjectError.captureStackTrace

prepareStackTrace() ​
ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters ​
ParameterType
errError
stackTracesCallSite[]
Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​

DataSubjectError.prepareStackTrace


DataSubjectService ​

Defined in: src/data-subject.service.ts:59

Constructors ​

Constructor ​
ts
new DataSubjectService(deps): DataSubjectService;

Defined in: src/data-subject.service.ts:68

Parameters ​
ParameterType
depsDataSubjectServiceDeps
Returns ​

DataSubjectService

Methods ​

erase() ​
ts
erase(
   subjectId,
   tenantId,
context?): Promise<DataSubjectRequest>;

Defined in: src/data-subject.service.ts:111

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
context?RequestContext
Returns ​

Promise<DataSubjectRequest>

expirePendingArtifacts() ​
ts
expirePendingArtifacts(limit?): Promise<{
  expired: number;
  failures: {
     code: string;
     requestId: string;
     tenantId: string;
  }[];
}>;

Defined in: src/data-subject.service.ts:147

Privileged bounded worker API. Schedule it to purge expired DB retry payloads.

Parameters ​
ParameterTypeDefault value
limitnumber100
Returns ​

Promise<{ expired: number; failures: { code: string; requestId: string; tenantId: string; }[]; }>

export() ​
ts
export(
   subjectId,
   tenantId,
context?): Promise<DataSubjectRequest>;

Defined in: src/data-subject.service.ts:103

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
context?RequestContext
Returns ​

Promise<DataSubjectRequest>

getArtifact() ​
ts
getArtifact(id, tenantId): Promise<
  | {
  body: Buffer;
  contentType: string;
}
| null>;

Defined in: src/data-subject.service.ts:179

Host authorization must also check the request's subject before serving its bytes.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise< | { body: Buffer; contentType: string; } | null>

getRequest() ​
ts
getRequest(id, tenantId): Promise<DataSubjectRequest>;

Defined in: src/data-subject.service.ts:172

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<DataSubjectRequest>

listByTenant() ​
ts
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;

Defined in: src/data-subject.service.ts:189

Parameters ​
ParameterType
tenantIdstring
opts{ state?: RequestState; }
opts.state?RequestState
Returns ​

Promise<DataSubjectRequest[]>

listOverdue() ​
ts
listOverdue(): Promise<DataSubjectRequest[]>;

Defined in: src/data-subject.service.ts:198

Privileged background administration API; do not expose as a tenant route.

Returns ​

Promise<DataSubjectRequest[]>

previewErase() ​
ts
previewErase(
   subjectId,
   tenantId,
options?): Promise<ErasurePreview>;

Defined in: src/data-subject.service.ts:120

Read-only: no request insert, mutation, outbox, audit, or artifact write.

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
options{ ttlMs?: number; }
options.ttlMs?number
Returns ​

Promise<ErasurePreview>

retryCompletion() ​
ts
retryCompletion(id, tenantId): Promise<DataSubjectRequest>;

Defined in: src/data-subject.service.ts:139

Retries only committed artifacts and durable notifications, never entity work.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<DataSubjectRequest>


ErasureVerificationError ​

Defined in: src/erase-runner.ts:14

Carries only policy names, counts and statuses, never selected row data.

Extends ​

Constructors ​

Constructor ​
ts
new ErasureVerificationError(result): ErasureVerificationError;

Defined in: src/erase-runner.ts:15

Parameters ​
ParameterType
resultEraseResult
Returns ​

ErasureVerificationError

Overrides ​

DataSubjectError.constructor

Properties ​

cause? ​
ts
optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​

DataSubjectError.cause

code ​
ts
readonly code: DataSubjectErrorCode;

Defined in: src/errors.ts:50

Inherited from ​

DataSubjectError.code

httpStatus ​
ts
readonly httpStatus: number;

Defined in: src/errors.ts:51

Inherited from ​

DataSubjectError.httpStatus

message ​
ts
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from ​

DataSubjectError.message

name ​
ts
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

DataSubjectError.name

result ​
ts
readonly result: EraseResult;

Defined in: src/erase-runner.ts:15

stack? ​
ts
optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​

DataSubjectError.stack

stackTraceLimit ​
ts
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​

DataSubjectError.stackTraceLimit

Accessors ​

actions ​
Get Signature ​
ts
get actions(): ErasureEvidenceAction[];

Defined in: src/erase-runner.ts:19

Returns ​

ErasureEvidenceAction[]

stats ​
Get Signature ​
ts
get stats(): RequestStats;

Defined in: src/erase-runner.ts:18

Returns ​

RequestStats

Methods ​

captureStackTrace() ​
ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters ​
ParameterType
targetObjectobject
constructorOpt?Function
Returns ​

void

Inherited from ​

DataSubjectError.captureStackTrace

prepareStackTrace() ​
ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters ​
ParameterType
errError
stackTracesCallSite[]
Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​

DataSubjectError.prepareStackTrace


InMemoryArtifactStorage ​

Defined in: src/storage/in-memory-artifact-storage.ts:3

Implements ​

Constructors ​

Constructor ​
ts
new InMemoryArtifactStorage(): InMemoryArtifactStorage;
Returns ​

InMemoryArtifactStorage

Methods ​

get() ​
ts
get(key): Promise<
  | {
  body: Buffer;
  contentType: string;
}
| null>;

Defined in: src/storage/in-memory-artifact-storage.ts:14

Parameters ​
ParameterType
keystring
Returns ​

Promise< | { body: Buffer; contentType: string; } | null>

Implementation of ​

ArtifactStorage.get

put() ​
ts
put(
   key,
   body,
contentType): Promise<string>;

Defined in: src/storage/in-memory-artifact-storage.ts:9

Parameters ​
ParameterType
keystring
bodyBuffer
contentTypestring
Returns ​

Promise<string>

Implementation of ​

ArtifactStorage.put


InMemoryRequestStorage ​

Defined in: src/storage/in-memory-request-storage.ts:12

Implements ​

Constructors ​

Constructor ​
ts
new InMemoryRequestStorage(): InMemoryRequestStorage;
Returns ​

InMemoryRequestStorage

Methods ​

findById() ​
ts
findById(id, tenantId): Promise<DataSubjectRequest | null>;

Defined in: src/storage/in-memory-request-storage.ts:50

A request outside the supplied tenant is indistinguishable from a missing request.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<DataSubjectRequest | null>

Implementation of ​

RequestStorage.findById

insert() ​
ts
insert(req): Promise<void>;

Defined in: src/storage/in-memory-request-storage.ts:15

Parameters ​
ParameterType
reqDataSubjectRequest
Returns ​

Promise<void>

Implementation of ​

RequestStorage.insert

listByTenant() ​
ts
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;

Defined in: src/storage/in-memory-request-storage.ts:57

Parameters ​
ParameterType
tenantIdstring
opts{ state?: RequestState; }
opts.state?RequestState
Returns ​

Promise<DataSubjectRequest[]>

Implementation of ​

RequestStorage.listByTenant

listOverdue() ​
ts
listOverdue(now): Promise<DataSubjectRequest[]>;

Defined in: src/storage/in-memory-request-storage.ts:68

Parameters ​
ParameterType
nowDate
Returns ​

Promise<DataSubjectRequest[]>

Implementation of ​

RequestStorage.listOverdue

update() ​
ts
update(
   id,
   tenantId,
patch): Promise<void>;

Defined in: src/storage/in-memory-request-storage.ts:27

Update within a tenant; request identity fields are immutable.

Parameters ​
ParameterType
idstring
tenantIdstring
patchPartial<DataSubjectRequest>
Returns ​

Promise<void>

Implementation of ​

RequestStorage.update


PostgresJobStore ​

Defined in: src/jobs/postgres-job-store.ts:42

One bounded page holds a PostgreSQL row lock. A crash rolls back both the page and its checkpoint. SKIP LOCKED lets other workers continue unrelated jobs. External I/O is not transactionally protected and requires its own idempotency.

Type Parameters ​

Type Parameter
TTransaction extends PostgresJobTransactionClient

Implements ​

Constructors ​

Constructor ​
ts
new PostgresJobStore<TTransaction>(opts): PostgresJobStore<TTransaction>;

Defined in: src/jobs/postgres-job-store.ts:53

Parameters ​
ParameterType
optsPostgresJobStoreOptions<TTransaction>
Returns ​

PostgresJobStore<TTransaction>

Methods ​

cancel() ​
ts
cancel(id, tenantId): Promise<JobRecord>;

Defined in: src/jobs/postgres-job-store.ts:105

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord>

Implementation of ​

DurableJobStore.cancel

deleteChunks() ​
ts
deleteChunks(id, tenantId): Promise<void>;

Defined in: src/jobs/postgres-job-store.ts:224

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<void>

Implementation of ​

DurableJobStore.deleteChunks

get() ​
ts
get(id, tenantId): Promise<JobRecord | null>;

Defined in: src/jobs/postgres-job-store.ts:97

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord | null>

Implementation of ​

DurableJobStore.get

purgeExpiredChunks() ​
ts
purgeExpiredChunks(limit?): Promise<number>;

Defined in: src/jobs/postgres-job-store.ts:238

Processes at most limit jobs and 1000 chunks per job; repeat until it returns zero.

Parameters ​
ParameterTypeDefault value
limitnumber100
Returns ​

Promise<number>

Implementation of ​

DurableJobStore.purgeExpiredChunks

readChunks() ​
ts
readChunks(id, tenantId): AsyncIterable<{
  body: Buffer;
  index: number;
}>;

Defined in: src/jobs/postgres-job-store.ts:197

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

AsyncIterable<{ body: Buffer; index: number; }>

Implementation of ​

DurableJobStore.readChunks

retry() ​
ts
retry(id, tenantId): Promise<JobRecord>;

Defined in: src/jobs/postgres-job-store.ts:115

Explicitly resume the committed checkpoint of a failed/cancelled job.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord>

Implementation of ​

DurableJobStore.retry

runNext() ​
ts
runNext(handler, filter?): Promise<JobRecord | null>;

Defined in: src/jobs/postgres-job-store.ts:130

One bounded transaction, never an unbounded loop or arbitrary external I/O.

Parameters ​
ParameterType
handlerJobHandler
filterJobFilter
Returns ​

Promise<JobRecord | null>

Implementation of ​

DurableJobStore.runNext

submit() ​
ts
submit(input): Promise<{
  created: boolean;
  job: JobRecord;
}>;

Defined in: src/jobs/postgres-job-store.ts:71

Parameters ​
ParameterType
inputJobSubmitInput
Returns ​

Promise<{ created: boolean; job: JobRecord; }>

Implementation of ​

DurableJobStore.submit


PrismaExecutionStore ​

Defined in: src/storage/prisma-execution-store.ts:67

PostgreSQL request reservation, row locking, and atomic execution/outbox persistence.

Type Parameters ​

Type Parameter
TTransaction extends PrismaExecutionTransactionClient

Implements ​

Constructors ​

Constructor ​
ts
new PrismaExecutionStore<TTransaction>(opts): PrismaExecutionStore<TTransaction>;

Defined in: src/storage/prisma-execution-store.ts:73

Parameters ​
ParameterType
optsPrismaExecutionStoreOptions<TTransaction>
Returns ​

PrismaExecutionStore<TTransaction>

Properties ​

requests ​
ts
readonly requests: PrismaRequestStorage;

Defined in: src/storage/prisma-execution-store.ts:69

Implementation of ​

DurableExecutionStore.requests

Methods ​

listExpiredArtifacts() ​
ts
listExpiredArtifacts(now, limit): Promise<{
  requestId: string;
  tenantId: string;
}[]>;

Defined in: src/storage/prisma-execution-store.ts:98

Administrative metadata scan. Recheck expiry under withLock before clearing bytes.

Parameters ​
ParameterType
nowDate
limitnumber
Returns ​

Promise<{ requestId: string; tenantId: string; }[]>

Implementation of ​

DurableExecutionStore.listExpiredArtifacts

reserve() ​
ts
reserve(
   request,
   idempotencyKey,
   payloadHash): Promise<{
  created: boolean;
  request: DataSubjectRequest;
}>;

Defined in: src/storage/prisma-execution-store.ts:116

Parameters ​
ParameterType
requestDataSubjectRequest
idempotencyKeystring
payloadHashstring
Returns ​

Promise<{ created: boolean; request: DataSubjectRequest; }>

Implementation of ​

DurableExecutionStore.reserve

withLock() ​
ts
withLock<T>(
   requestId,
   tenantId,
work): Promise<T>;

Defined in: src/storage/prisma-execution-store.ts:161

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
requestIdstring
tenantIdstring
work(transaction) => Promise<T>
Returns ​

Promise<T>

Implementation of ​

DurableExecutionStore.withLock


PrismaRequestStorage ​

Defined in: src/storage/prisma-request-storage.ts:35

Implements ​

Constructors ​

Constructor ​
ts
new PrismaRequestStorage(opts): PrismaRequestStorage;

Defined in: src/storage/prisma-request-storage.ts:36

Parameters ​
ParameterType
optsPrismaRequestStorageOptions
Returns ​

PrismaRequestStorage

Methods ​

findById() ​
ts
findById(id, tenantId): Promise<DataSubjectRequest | null>;

Defined in: src/storage/prisma-request-storage.ts:77

A request outside the supplied tenant is indistinguishable from a missing request.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<DataSubjectRequest | null>

Implementation of ​

RequestStorage.findById

insert() ​
ts
insert(req): Promise<void>;

Defined in: src/storage/prisma-request-storage.ts:38

Parameters ​
ParameterType
reqDataSubjectRequest
Returns ​

Promise<void>

Implementation of ​

RequestStorage.insert

listByTenant() ​
ts
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;

Defined in: src/storage/prisma-request-storage.ts:84

Parameters ​
ParameterType
tenantIdstring
opts{ state?: RequestState; }
opts.state?RequestState
Returns ​

Promise<DataSubjectRequest[]>

Implementation of ​

RequestStorage.listByTenant

listOverdue() ​
ts
listOverdue(now): Promise<DataSubjectRequest[]>;

Defined in: src/storage/prisma-request-storage.ts:99

Parameters ​
ParameterType
nowDate
Returns ​

Promise<DataSubjectRequest[]>

Implementation of ​

RequestStorage.listOverdue

update() ​
ts
update(
   id,
   tenantId,
patch): Promise<void>;

Defined in: src/storage/prisma-request-storage.ts:53

Update within a tenant; request identity fields are immutable.

Parameters ​
ParameterType
idstring
tenantIdstring
patchPartial<DataSubjectRequest>
Returns ​

Promise<void>

Implementation of ​

RequestStorage.update


Registry ​

Defined in: src/registry.ts:11

Constructors ​

Constructor ​
ts
new Registry(opts?): Registry;

Defined in: src/registry.ts:15

Parameters ​
ParameterType
optsCompileOptions
Returns ​

Registry

Methods ​

definitions() ​
ts
definitions(): EntityDefinition[];

Defined in: src/registry.ts:66

Returns ​

EntityDefinition[]

get() ​
ts
get(name): RegisteredEntity | undefined;

Defined in: src/registry.ts:39

Parameters ​
ParameterType
namestring
Returns ​

RegisteredEntity | undefined

list() ​
ts
list(): RegisteredEntity[];

Defined in: src/registry.ts:70

Returns ​

RegisteredEntity[]

register() ​
ts
register(input): void;

Defined in: src/registry.ts:17

Parameters ​
ParameterType
inputRegisterInput
Returns ​

void

registerDefinition() ​
ts
registerDefinition(definition, executor): void;

Defined in: src/registry.ts:43

Parameters ​
ParameterType
definitionEntityDefinition
executorEntityExecutor
Returns ​

void


TranscendErasureAdapter ​

Defined in: src/integrations/transcend.ts:89

Experimental server-webhook adapter, independently scoped to one local erasure system.

Constructors ​

Constructor ​
ts
new TranscendErasureAdapter(options): TranscendErasureAdapter;

Defined in: src/integrations/transcend.ts:96

Parameters ​
ParameterType
optionsTranscendAdapterOptions
Returns ​

TranscendErasureAdapter

Methods ​

processStep() ​
ts
processStep(__namedParameters): Promise<JobStepResult>;

Defined in: src/integrations/transcend.ts:242

Use with jobs.runNext(adapter.processStep.bind(adapter), { kind: TRANSCEND_ERASURE_JOB }).

Parameters ​
ParameterType
__namedParametersPick<JobTransaction, "job">
Returns ​

Promise<JobStepResult>

receive() ​
ts
receive(input): Promise<{
  created: boolean;
  job: JobRecord;
}>;

Defined in: src/integrations/transcend.ts:152

Return HTTP 200 only after this resolves: receipt is not erasure completion.

Parameters ​
ParameterType
input{ body: Buffer; headers: Record<string, string | string[] | undefined>; }
input.bodyBuffer
input.headersRecord<string, string | string[] | undefined>
Returns ​

Promise<{ created: boolean; job: JobRecord; }>


TranscendIntegrationError ​

Defined in: src/integrations/transcend-auth.ts:3

Extends ​

  • Error

Constructors ​

Constructor ​
ts
new TranscendIntegrationError(code, retryable?): TranscendIntegrationError;

Defined in: src/integrations/transcend-auth.ts:4

Parameters ​
ParameterTypeDefault value
code| "invalid_configuration" | "invalid_webhook" | "unauthorized_webhook" | "unsupported_request" | "subject_not_mapped" | "invalid_job" | "provider_unavailable" | "local_execution_incomplete"undefined
retryablebooleanfalse
Returns ​

TranscendIntegrationError

Overrides ​
ts
Error.constructor

Properties ​

cause? ​
ts
optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​
ts
Error.cause

code ​
ts
readonly code:
  | "invalid_configuration"
  | "invalid_webhook"
  | "unauthorized_webhook"
  | "unsupported_request"
  | "subject_not_mapped"
  | "invalid_job"
  | "provider_unavailable"
  | "local_execution_incomplete";

Defined in: src/integrations/transcend-auth.ts:5

message ​
ts
message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from ​
ts
Error.message

name ​
ts
name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​
ts
Error.name

retryable ​
ts
readonly retryable: boolean = false;

Defined in: src/integrations/transcend-auth.ts:14

stack? ​
ts
optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​
ts
Error.stack

stackTraceLimit ​
ts
static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​
ts
Error.stackTraceLimit

Methods ​

captureStackTrace() ​
ts
static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
Parameters ​
ParameterType
targetObjectobject
constructorOpt?Function
Returns ​

void

Inherited from ​
ts
Error.captureStackTrace

prepareStackTrace() ​
ts
static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters ​
ParameterType
errError
stackTracesCallSite[]
Returns ​

any

See ​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from ​
ts
Error.prepareStackTrace

Interfaces ​

ArtifactStorage ​

Defined in: src/storage/artifact-storage.interface.ts:1

Methods ​

get() ​
ts
get(key): Promise<
  | {
  body: Buffer;
  contentType: string;
}
| null>;

Defined in: src/storage/artifact-storage.interface.ts:3

Parameters ​
ParameterType
keystring
Returns ​

Promise< | { body: Buffer; contentType: string; } | null>

put() ​
ts
put(
   key,
   body,
contentType): Promise<string>;

Defined in: src/storage/artifact-storage.interface.ts:2

Parameters ​
ParameterType
keystring
bodyBuffer
contentTypestring
Returns ​

Promise<string>


CompileOptions ​

Defined in: src/policy-compiler.ts:5

Properties ​

strictLegalBasis? ​
ts
optional strictLegalBasis?: boolean;

Defined in: src/policy-compiler.ts:6


DataSubjectModuleOptions ​

Defined in: src/data-subject.module.ts:12

Properties ​

allowUnverified? ​
ts
optional allowUnverified?: boolean;

Defined in: src/data-subject.module.ts:24

artifactRetryTtlMs? ​
ts
optional artifactRetryTtlMs?: {
  erase?: number;
  export?: number;
};

Defined in: src/data-subject.module.ts:21

erase? ​
ts
optional erase?: number;
export? ​
ts
optional export?: number;

artifactStorage ​
ts
artifactStorage: ArtifactStorage;

Defined in: src/data-subject.module.ts:14

definitions? ​
ts
optional definitions?: {
  definition: EntityDefinition;
  executor: EntityExecutor;
}[];

Defined in: src/data-subject.module.ts:19

definition ​
ts
definition: EntityDefinition;
executor ​
ts
executor: EntityExecutor;

durableStore? ​
ts
optional durableStore?: DurableExecutionStore;

Defined in: src/data-subject.module.ts:20

entities? ​
ts
optional entities?: RegisterInput[];

Defined in: src/data-subject.module.ts:18

previewSigningKey? ​
ts
optional previewSigningKey?: string | Buffer<ArrayBufferLike>;

Defined in: src/data-subject.module.ts:22

previewTtlMs? ​
ts
optional previewTtlMs?: number;

Defined in: src/data-subject.module.ts:23

publishAudit? ​
ts
optional publishAudit?: (event, data, delivery?) => Promise<void>;

Defined in: src/data-subject.module.ts:26

Parameters ​
ParameterType
eventstring
dataRecord<string, unknown>
delivery?DeliveryContext
Returns ​

Promise<void>

publishOutbox? ​
ts
optional publishOutbox?: (type, payload, delivery?) => Promise<void>;

Defined in: src/data-subject.module.ts:25

Parameters ​
ParameterType
typestring
payloadunknown
delivery?DeliveryContext
Returns ​

Promise<void>

requestStorage ​
ts
requestStorage: RequestStorage;

Defined in: src/data-subject.module.ts:13

runInTransaction? ​
ts
optional runInTransaction?: <T>(work) => Promise<T>;

Defined in: src/data-subject.module.ts:27

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
work() => Promise<T>
Returns ​

Promise<T>

singleTenantId? ​
ts
optional singleTenantId?: string;

Defined in: src/data-subject.module.ts:16

slaDays? ​
ts
optional slaDays?: number;

Defined in: src/data-subject.module.ts:15

strictLegalBasis? ​
ts
optional strictLegalBasis?: boolean;

Defined in: src/data-subject.module.ts:17


DataSubjectRequest ​

Defined in: src/types.ts:57

Properties ​

artifactHash ​
ts
artifactHash: string | null;

Defined in: src/types.ts:68

artifactUrl ​
ts
artifactUrl: string | null;

Defined in: src/types.ts:69

completedAt ​
ts
completedAt: Date | null;

Defined in: src/types.ts:65

createdAt ​
ts
createdAt: Date;

Defined in: src/types.ts:63

dueAt ​
ts
dueAt: Date;

Defined in: src/types.ts:64

failedAt ​
ts
failedAt: Date | null;

Defined in: src/types.ts:66

failureReason ​
ts
failureReason: string | null;

Defined in: src/types.ts:67

id ​
ts
id: string;

Defined in: src/types.ts:58

requestedBy ​
ts
requestedBy: string | null;

Defined in: src/types.ts:71

state ​
ts
state: RequestState;

Defined in: src/types.ts:62

stats ​
ts
stats: RequestStats | null;

Defined in: src/types.ts:70

subjectId ​
ts
subjectId: string;

Defined in: src/types.ts:60

tenantId ​
ts
tenantId: string;

Defined in: src/types.ts:59

type ​
ts
type: RequestType;

Defined in: src/types.ts:61


DataSubjectServiceDeps ​

Defined in: src/data-subject.service.ts:33

Properties ​

allowUnverified? ​
ts
optional allowUnverified?: boolean;

Defined in: src/data-subject.service.ts:46

Legacy integrations only. Durable execution always requires verification.

artifactRetryTtlMs? ​
ts
optional artifactRetryTtlMs?: {
  erase?: number;
  export?: number;
};

Defined in: src/data-subject.service.ts:42

Retry-payload TTL from request creation; remote artifact retention is separate.

erase? ​
ts
optional erase?: number;
export? ​
ts
optional export?: number;

artifactStorage ​
ts
artifactStorage: ArtifactStorage;

Defined in: src/data-subject.service.ts:36

clock? ​
ts
optional clock?: () => Date;

Defined in: src/data-subject.service.ts:48

Returns ​

Date

durableStore? ​
ts
optional durableStore?: DurableExecutionStore;

Defined in: src/data-subject.service.ts:40

idFactory? ​
ts
optional idFactory?: () => string;

Defined in: src/data-subject.service.ts:47

Returns ​

string

previewSigningKey? ​
ts
optional previewSigningKey?: string | Buffer<ArrayBufferLike>;

Defined in: src/data-subject.service.ts:43

previewTtlMs? ​
ts
optional previewTtlMs?: number;

Defined in: src/data-subject.service.ts:44

publishAudit? ​
ts
optional publishAudit?: (event, data, delivery?) => Promise<void>;

Defined in: src/data-subject.service.ts:50

Parameters ​
ParameterType
eventstring
dataRecord<string, unknown>
delivery?DeliveryContext
Returns ​

Promise<void>

publishOutbox? ​
ts
optional publishOutbox?: (type, payload, delivery?) => Promise<void>;

Defined in: src/data-subject.service.ts:49

Parameters ​
ParameterType
typestring
payloadunknown
delivery?DeliveryContext
Returns ​

Promise<void>

registry ​
ts
registry: Registry;

Defined in: src/data-subject.service.ts:34

requestStorage ​
ts
requestStorage: RequestStorage;

Defined in: src/data-subject.service.ts:35

runInTransaction? ​
ts
optional runInTransaction?: <T>(work) => Promise<T>;

Defined in: src/data-subject.service.ts:56

Bind every executor to the transaction client; resolve only after commit.

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
work() => Promise<T>
Returns ​

Promise<T>

singleTenantId? ​
ts
optional singleTenantId?: string;

Defined in: src/data-subject.service.ts:39

Omit for multi-tenant mode. Every executor must declare a matching scope.

slaDays ​
ts
slaDays: number;

Defined in: src/data-subject.service.ts:37


DeliveryContext ​

Defined in: src/durable-coordinator.ts:18

Properties ​

id ​
ts
id: string;

Defined in: src/durable-coordinator.ts:19

requestId ​
ts
requestId: string;

Defined in: src/durable-coordinator.ts:20

tenantId ​
ts
tenantId: string;

Defined in: src/durable-coordinator.ts:21


DurableArtifact ​

Defined in: src/storage/durable-execution-store.interface.ts:5

Bytes are cleared atomically with request completion after upload succeeds.

Properties ​

bodyBase64 ​
ts
bodyBase64: string | null;

Defined in: src/storage/durable-execution-store.interface.ts:8

contentType ​
ts
contentType: string;

Defined in: src/storage/durable-execution-store.interface.ts:7

discardedAt? ​
ts
optional discardedAt?: string;

Defined in: src/storage/durable-execution-store.interface.ts:12

expiresAt? ​
ts
optional expiresAt?: string;

Defined in: src/storage/durable-execution-store.interface.ts:11

hash ​
ts
hash: string;

Defined in: src/storage/durable-execution-store.interface.ts:9

key ​
ts
key: string;

Defined in: src/storage/durable-execution-store.interface.ts:6

url? ​
ts
optional url?: string;

Defined in: src/storage/durable-execution-store.interface.ts:10


DurableExecutionStore ​

Defined in: src/storage/durable-execution-store.interface.ts:45

One database only: host executors must use the transaction supplied by the store.

Properties ​

requests ​
ts
readonly requests: RequestStorage;

Defined in: src/storage/durable-execution-store.interface.ts:46

Methods ​

listExpiredArtifacts() ​
ts
listExpiredArtifacts(now, limit): Promise<{
  requestId: string;
  tenantId: string;
}[]>;

Defined in: src/storage/durable-execution-store.interface.ts:48

Administrative metadata scan. Recheck expiry under withLock before clearing bytes.

Parameters ​
ParameterType
nowDate
limitnumber
Returns ​

Promise<{ requestId: string; tenantId: string; }[]>

reserve() ​
ts
reserve(
   request,
   idempotencyKey,
   payloadHash): Promise<{
  created: boolean;
  request: DataSubjectRequest;
}>;

Defined in: src/storage/durable-execution-store.interface.ts:49

Parameters ​
ParameterType
requestDataSubjectRequest
idempotencyKeystring
payloadHashstring
Returns ​

Promise<{ created: boolean; request: DataSubjectRequest; }>

withLock() ​
ts
withLock<T>(
   requestId,
   tenantId,
work): Promise<T>;

Defined in: src/storage/durable-execution-store.interface.ts:54

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
requestIdstring
tenantIdstring
work(transaction) => Promise<T>
Returns ​

Promise<T>


DurableJobStore ​

Defined in: src/jobs/types.ts:57

Methods ​

cancel() ​
ts
cancel(id, tenantId): Promise<JobRecord>;

Defined in: src/jobs/types.ts:60

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord>

deleteChunks() ​
ts
deleteChunks(id, tenantId): Promise<void>;

Defined in: src/jobs/types.ts:66

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<void>

get() ​
ts
get(id, tenantId): Promise<JobRecord | null>;

Defined in: src/jobs/types.ts:59

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord | null>

purgeExpiredChunks() ​
ts
purgeExpiredChunks(limit?): Promise<number>;

Defined in: src/jobs/types.ts:68

Processes at most limit jobs and 1000 chunks per job; repeat until it returns zero.

Parameters ​
ParameterType
limit?number
Returns ​

Promise<number>

readChunks() ​
ts
readChunks(id, tenantId): AsyncIterable<{
  body: Buffer;
  index: number;
}>;

Defined in: src/jobs/types.ts:65

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

AsyncIterable<{ body: Buffer; index: number; }>

retry() ​
ts
retry(id, tenantId): Promise<JobRecord>;

Defined in: src/jobs/types.ts:62

Explicitly resume the committed checkpoint of a failed/cancelled job.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<JobRecord>

runNext() ​
ts
runNext(handler, filter?): Promise<JobRecord | null>;

Defined in: src/jobs/types.ts:64

One bounded transaction, never an unbounded loop or arbitrary external I/O.

Parameters ​
ParameterType
handlerJobHandler
filter?JobFilter
Returns ​

Promise<JobRecord | null>

submit() ​
ts
submit(input): Promise<{
  created: boolean;
  job: JobRecord;
}>;

Defined in: src/jobs/types.ts:58

Parameters ​
ParameterType
inputJobSubmitInput
Returns ​

Promise<{ created: boolean; job: JobRecord; }>


EntityDefinition ​

Defined in: src/policy-definition.ts:6

One JSON-compatible policy source shared by registration and schema lint.

Extends ​

Properties ​

dependsOn? ​
ts
optional dependsOn?: string[];

Defined in: src/policy-compiler.ts:19

Parent entities: this entity is erased before each named parent.

Inherited from ​

PolicySpec.dependsOn

entityName ​
ts
entityName: string;

Defined in: src/policy-compiler.ts:10

Inherited from ​

PolicySpec.entityName

exportFields? ​
ts
optional exportFields?: string[];

Defined in: src/policy-compiler.ts:15

Explicit top-level export allowlist. Omit for an erase-only entity.

Inherited from ​

PolicySpec.exportFields

fields ​
ts
fields: Record<string, PolicyEntry>;

Defined in: src/policy-compiler.ts:13

Inherited from ​

PolicySpec.fields

ignoredFields? ​
ts
optional ignoredFields?: Record<string, string>;

Defined in: src/policy-definition.ts:9

Every deliberate scalar-field exclusion has an auditable explanation.

relations? ​
ts
optional relations?: string[];

Defined in: src/policy-definition.ts:11

Explicit Prisma relation field names reviewed by schema lint.

rowLevel? ​
ts
optional rowLevel?: "delete-row" | "delete-fields";

Defined in: src/policy-compiler.ts:12

Inherited from ​

PolicySpec.rowLevel

scope ​
ts
scope: TenantScope;

Defined in: src/policy-definition.ts:7

stableIdField? ​
ts
optional stableIdField?: string;

Defined in: src/policy-compiler.ts:17

Immutable row identity used for post-write verification.

Inherited from ​

PolicySpec.stableIdField

subjectField ​
ts
subjectField: string;

Defined in: src/policy-compiler.ts:11

Inherited from ​

PolicySpec.subjectField


EntityExecutor ​

Defined in: src/types.ts:35

Properties ​

identityField? ​
ts
optional identityField?: string;

Defined in: src/types.ts:38

scope? ​
ts
optional scope?: TenantScope;

Defined in: src/types.ts:37

Required at runtime by DataSubjectService; custom executors must enforce this scope.

Methods ​

anonymize() ​
ts
anonymize(
   subjectId,
   tenantId,
replacements): Promise<number>;

Defined in: src/types.ts:42

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
replacementsRecord<string, unknown>
Returns ​

Promise<number>

erase() ​
ts
erase(
   subjectId,
   tenantId,
plan): Promise<number>;

Defined in: src/types.ts:41

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
planErasePlan
Returns ​

Promise<number>

select() ​
ts
select(subjectId, tenantId): Promise<Record<string, unknown>[]>;

Defined in: src/types.ts:40

Parameters ​
ParameterType
subjectIdstring
tenantIdstring
Returns ​

Promise<Record<string, unknown>[]>

selectByIds()? ​
ts
optional selectByIds(ids, tenantId): Promise<Record<string, unknown>[]>;

Defined in: src/types.ts:39

Parameters ​
ParameterType
idsunknown[]
tenantIdstring
Returns ​

Promise<Record<string, unknown>[]>


EntityPolicy ​

Defined in: src/types.ts:16

Properties ​

dependsOn? ​
ts
optional dependsOn?: string[];

Defined in: src/types.ts:23

entityName ​
ts
entityName: string;

Defined in: src/types.ts:17

exportFields ​
ts
exportFields: string[];

Defined in: src/types.ts:21

fields ​
ts
fields: Record<string, PolicyEntry>;

Defined in: src/types.ts:20

rowLevel ​
ts
rowLevel: RowLevel;

Defined in: src/types.ts:19

stableIdField? ​
ts
optional stableIdField?: string;

Defined in: src/types.ts:22

subjectField ​
ts
subjectField: string;

Defined in: src/types.ts:18


EntityVerification ​

Defined in: src/types.ts:161

Properties ​

checkedRows ​
ts
checkedRows: number;

Defined in: src/types.ts:163

fields ​
ts
fields: {
  checked: number;
  field: string;
  status: "failed" | "verified" | "unverified";
  strategy: Strategy;
}[];

Defined in: src/types.ts:164

checked ​
ts
checked: number;
field ​
ts
field: string;
status ​
ts
status: "failed" | "verified" | "unverified";
strategy ​
ts
strategy: Strategy;

status ​
ts
status: "failed" | "verified" | "unverified";

Defined in: src/types.ts:162


ErasePlan ​

Defined in: src/types.ts:26

Properties ​

deleteFields ​
ts
deleteFields: string[];

Defined in: src/types.ts:28

rowLevel ​
ts
rowLevel: RowLevel;

Defined in: src/types.ts:27


ErasureEvidenceAction ​

Defined in: src/types.ts:127

Properties ​

affected ​
ts
affected: number;

Defined in: src/types.ts:130

anonymizedFields? ​
ts
optional anonymizedFields?: string[];

Defined in: src/types.ts:135

deleteFields? ​
ts
optional deleteFields?: string[];

Defined in: src/types.ts:134

effectiveRowStrategy? ​
ts
optional effectiveRowStrategy?: "retain" | "delete-row" | "update-fields";

Defined in: src/types.ts:132

entityName ​
ts
entityName: string;

Defined in: src/types.ts:128

retainedFields? ​
ts
optional retainedFields?: {
  count: number;
  field: string;
  legalBasis: string;
  until?: string;
}[];

Defined in: src/types.ts:136

count ​
ts
count: number;
field ​
ts
field: string;
legalBasis ​
ts
legalBasis: string;
until? ​
ts
optional until?: string;

rowLevel ​
ts
rowLevel: RowLevel;

Defined in: src/types.ts:131

strategy ​
ts
strategy: Strategy | "mixed";

Defined in: src/types.ts:129

verification? ​
ts
optional verification?: EntityVerification;

Defined in: src/types.ts:133


ErasureEvidenceArtifact ​

Defined in: src/types.ts:144

Properties ​

actions ​
ts
actions: ErasureEvidenceAction[];

Defined in: src/types.ts:155

artifactHashAlgorithm ​
ts
artifactHashAlgorithm: "sha256";

Defined in: src/types.ts:158

failureStage? ​
ts
optional failureStage?: FailureStage;

Defined in: src/types.ts:148

generatedAt ​
ts
generatedAt: string;

Defined in: src/types.ts:152

policyHash? ​
ts
optional policyHash?: string;

Defined in: src/types.ts:146

postScan ​
ts
postScan: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:156

count ​
ts
count: number;
entityName ​
ts
entityName: string;

preScan ​
ts
preScan: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:154

count ​
ts
count: number;
entityName ​
ts
entityName: string;

requestId ​
ts
requestId: string;

Defined in: src/types.ts:149

requestType ​
ts
requestType: "erase";

Defined in: src/types.ts:151

schemaVersion ​
ts
schemaVersion:
  | "data-subject.erasure-evidence.v1"
  | "data-subject.erasure-evidence.v2";

Defined in: src/types.ts:145

state ​
ts
state: "completed" | "failed";

Defined in: src/types.ts:153

tenantId ​
ts
tenantId: string;

Defined in: src/types.ts:150

verificationOverall? ​
ts
optional verificationOverall?: "failed" | "verified" | "unverified";

Defined in: src/types.ts:147

verificationResidual ​
ts
verificationResidual: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:157

count ​
ts
count: number;
entityName ​
ts
entityName: string;

ErasurePlanEntity ​

Defined in: src/erasure-plan.ts:9

Properties ​

anonymizedFields ​
ts
anonymizedFields: string[];

Defined in: src/erasure-plan.ts:14

deleteFields ​
ts
deleteFields: string[];

Defined in: src/erasure-plan.ts:13

effectiveRowStrategy ​
ts
effectiveRowStrategy: EffectiveRowStrategy;

Defined in: src/erasure-plan.ts:12

entityName ​
ts
entityName: string;

Defined in: src/erasure-plan.ts:10

expectedRows ​
ts
expectedRows: number;

Defined in: src/erasure-plan.ts:11

retainedFields ​
ts
retainedFields: {
  field: string;
  legalBasis: string;
  until?: string;
}[];

Defined in: src/erasure-plan.ts:15

field ​
ts
field: string;
legalBasis ​
ts
legalBasis: string;
until? ​
ts
optional until?: string;

verification ​
ts
verification: "available" | "unavailable";

Defined in: src/erasure-plan.ts:16


ErasurePlanSummary ​

Defined in: src/erasure-plan.ts:20

Contains counts and fingerprints, never selected values or row identifiers.

Properties ​

entities ​
ts
entities: ErasurePlanEntity[];

Defined in: src/erasure-plan.ts:24

policyHash ​
ts
policyHash: string;

Defined in: src/erasure-plan.ts:22

schemaVersion ​
ts
schemaVersion: "data-subject.erasure-plan.v1";

Defined in: src/erasure-plan.ts:21

scopeHash ​
ts
scopeHash: string;

Defined in: src/erasure-plan.ts:23


ErasurePreview ​

Defined in: src/preview.ts:7

Properties ​

expiresAt ​
ts
expiresAt: string;

Defined in: src/preview.ts:12

issuedAt ​
ts
issuedAt: string;

Defined in: src/preview.ts:11

plan ​
ts
plan: ErasurePlanSummary;

Defined in: src/preview.ts:13

schemaVersion ​
ts
schemaVersion: "data-subject.preview.v1";

Defined in: src/preview.ts:8

signature ​
ts
signature: string;

Defined in: src/preview.ts:14

subjectId ​
ts
subjectId: string;

Defined in: src/preview.ts:9

tenantId ​
ts
tenantId: string;

Defined in: src/preview.ts:10


ExecutionNotification ​

Defined in: src/storage/durable-execution-store.interface.ts:16

Delivery is at least once. Consumers must deduplicate by this stable id.

Properties ​

channel ​
ts
channel: "outbox" | "audit";

Defined in: src/storage/durable-execution-store.interface.ts:18

delivered ​
ts
delivered: boolean;

Defined in: src/storage/durable-execution-store.interface.ts:21

event ​
ts
event: string;

Defined in: src/storage/durable-execution-store.interface.ts:19

id ​
ts
id: string;

Defined in: src/storage/durable-execution-store.interface.ts:17

lastError? ​
ts
optional lastError?: string;

Defined in: src/storage/durable-execution-store.interface.ts:22

payload ​
ts
payload: Record<string, unknown>;

Defined in: src/storage/durable-execution-store.interface.ts:20


ExecutionRecord ​

Defined in: src/storage/durable-execution-store.interface.ts:25

Properties ​

artifact ​
ts
artifact: DurableArtifact | null;

Defined in: src/storage/durable-execution-store.interface.ts:32

idempotencyKey ​
ts
readonly idempotencyKey: string;

Defined in: src/storage/durable-execution-store.interface.ts:29

notifications ​
ts
notifications: ExecutionNotification[];

Defined in: src/storage/durable-execution-store.interface.ts:34

payloadHash ​
ts
readonly payloadHash: string;

Defined in: src/storage/durable-execution-store.interface.ts:30

phase ​
ts
phase: "completed" | "pending" | "data_committed";

Defined in: src/storage/durable-execution-store.interface.ts:31

requestId ​
ts
readonly requestId: string;

Defined in: src/storage/durable-execution-store.interface.ts:26

stats ​
ts
stats: RequestStats | null;

Defined in: src/storage/durable-execution-store.interface.ts:33

tenantId ​
ts
readonly tenantId: string;

Defined in: src/storage/durable-execution-store.interface.ts:27

type ​
ts
readonly type: RequestType;

Defined in: src/storage/durable-execution-store.interface.ts:28


ExecutionTransaction ​

Defined in: src/storage/durable-execution-store.interface.ts:37

Properties ​

record ​
ts
record: ExecutionRecord;

Defined in: src/storage/durable-execution-store.interface.ts:38

requests ​
ts
requests: RequestStorage;

Defined in: src/storage/durable-execution-store.interface.ts:40

Uses the same database transaction as the locked execution and bound executors.

Methods ​

save() ​
ts
save(record): Promise<void>;

Defined in: src/storage/durable-execution-store.interface.ts:41

Parameters ​
ParameterType
recordExecutionRecord
Returns ​

Promise<void>


FromPrismaOptions ​

Defined in: src/prisma/from-prisma.ts:17

Properties ​

delegate ​
ts
delegate: PrismaDelegate;

Defined in: src/prisma/from-prisma.ts:18

singleTenantId? ​
ts
optional singleTenantId?: string;

Defined in: src/prisma/from-prisma.ts:22

Explicit scope for databases which contain exactly one tenant.

stableIdField? ​
ts
optional stableIdField?: string;

Defined in: src/prisma/from-prisma.ts:24

Immutable unique scalar key used to verify rows after subject-field updates.

subjectField ​
ts
subjectField: string;

Defined in: src/prisma/from-prisma.ts:19

tenantField? ​
ts
optional tenantField?: string;

Defined in: src/prisma/from-prisma.ts:20


JobFilter ​

Defined in: src/jobs/types.ts:55

Properties ​

kind? ​
ts
optional kind?: string;

Defined in: src/jobs/types.ts:55

tenantId? ​
ts
optional tenantId?: string;

Defined in: src/jobs/types.ts:55


JobRecord ​

Defined in: src/jobs/types.ts:12

Extends ​

Properties ​

attempts ​
ts
attempts: number;

Defined in: src/jobs/types.ts:21

Consecutive failed steps. A successfully committed page resets this count.

availableAt ​
ts
availableAt: Date;

Defined in: src/jobs/types.ts:29

checkpoint ​
ts
checkpoint: JobJson;

Defined in: src/jobs/types.ts:15

chunksDeletedAt ​
ts
chunksDeletedAt: Date | null;

Defined in: src/jobs/types.ts:31

chunksWritten ​
ts
chunksWritten: number;

Defined in: src/jobs/types.ts:19

completedAt ​
ts
completedAt: Date | null;

Defined in: src/jobs/types.ts:30

createdAt ​
ts
createdAt: Date;

Defined in: src/jobs/types.ts:27

expiresAt ​
ts
expiresAt: Date;

Defined in: src/jobs/types.ts:33

Immutable payload/chunk retention deadline, measured by the database clock.

hasCommittedChanges ​
ts
hasCommittedChanges: boolean;

Defined in: src/jobs/types.ts:23

id ​
ts
id: string;

Defined in: src/jobs/types.ts:5

Inherited from ​

JobSubmitInput.id

idempotencyKey ​
ts
idempotencyKey: string;

Defined in: src/jobs/types.ts:8

Inherited from ​

JobSubmitInput.idempotencyKey

kind ​
ts
kind: string;

Defined in: src/jobs/types.ts:7

Inherited from ​

JobSubmitInput.kind

lastError ​
ts
lastError: string | null;

Defined in: src/jobs/types.ts:26

pagesCommitted ​
ts
pagesCommitted: number;

Defined in: src/jobs/types.ts:18

partial ​
ts
partial: boolean;

Defined in: src/jobs/types.ts:25

Failed/cancelled with committed changes, or possible external changes requiring reconciliation.

payload ​
ts
payload: JobJson;

Defined in: src/jobs/types.ts:9

Inherited from ​

JobSubmitInput.payload

payloadHash ​
ts
readonly payloadHash: string;

Defined in: src/jobs/types.ts:13

processedRows ​
ts
processedRows: number;

Defined in: src/jobs/types.ts:17

purgedAt ​
ts
purgedAt: Date | null;

Defined in: src/jobs/types.ts:34

result ​
ts
result: JobJson;

Defined in: src/jobs/types.ts:16

revision ​
ts
revision: number;

Defined in: src/jobs/types.ts:22

state ​
ts
state: "completed" | "failed" | "queued" | "cancelled";

Defined in: src/jobs/types.ts:14

tenantId ​
ts
tenantId: string;

Defined in: src/jobs/types.ts:6

Inherited from ​

JobSubmitInput.tenantId

updatedAt ​
ts
updatedAt: Date;

Defined in: src/jobs/types.ts:28


JobStepResult ​

Defined in: src/jobs/types.ts:37

Properties ​

checkpoint ​
ts
checkpoint: JobJson;

Defined in: src/jobs/types.ts:39

done ​
ts
done: boolean;

Defined in: src/jobs/types.ts:38

hasCommittedChanges? ​
ts
optional hasCommittedChanges?: boolean;

Defined in: src/jobs/types.ts:43

Set for business mutations, or before external work whose commit may be uncertain. Retain/export alone do not count.

processedRows ​
ts
processedRows: number;

Defined in: src/jobs/types.ts:41

Number of scope rows processed by this page, not a cumulative total.

result? ​
ts
optional result?: JobJson;

Defined in: src/jobs/types.ts:44


JobSubmitInput ​

Defined in: src/jobs/types.ts:4

Extended by ​

Properties ​

id ​
ts
id: string;

Defined in: src/jobs/types.ts:5

idempotencyKey ​
ts
idempotencyKey: string;

Defined in: src/jobs/types.ts:8

kind ​
ts
kind: string;

Defined in: src/jobs/types.ts:7

payload ​
ts
payload: JobJson;

Defined in: src/jobs/types.ts:9

tenantId ​
ts
tenantId: string;

Defined in: src/jobs/types.ts:6


JobTransaction ​

Defined in: src/jobs/types.ts:47

Properties ​

job ​
ts
readonly job: JobRecord;

Defined in: src/jobs/types.ts:49

Snapshot of the locked job. Mutating this object does not persist anything.

Methods ​

appendChunk() ​
ts
appendChunk(body): Promise<void>;

Defined in: src/jobs/types.ts:51

At most one bounded immutable chunk per page, committed with the checkpoint.

Parameters ​
ParameterType
bodyBuffer
Returns ​

Promise<void>


LegalBasisOptions ​

Defined in: src/legal-basis.ts:1

Properties ​

strict? ​
ts
optional strict?: boolean;

Defined in: src/legal-basis.ts:2


PagedEntityExecutor ​

Defined in: src/jobs/paged-privacy.ts:22

Every method must use the same transaction connection as its JobTransaction.

Properties ​

identityField ​
ts
identityField: string;

Defined in: src/jobs/paged-privacy.ts:23

scope ​
ts
scope: TenantScope;

Defined in: src/jobs/paged-privacy.ts:24

Methods ​

eraseByIds() ​
ts
eraseByIds(ids, tenantId): Promise<number>;

Defined in: src/jobs/paged-privacy.ts:28

Parameters ​
ParameterType
idsPagedId[]
tenantIdstring
Returns ​

Promise<number>

highWatermark() ​
ts
highWatermark(input): Promise<PagedId | null>;

Defined in: src/jobs/paged-privacy.ts:25

Parameters ​
ParameterType
input{ subjectId: string; tenantId: string; }
input.subjectIdstring
input.tenantIdstring
Returns ​

Promise<PagedId | null>

readPage() ​
ts
readPage(input): Promise<Record<string, unknown>[]>;

Defined in: src/jobs/paged-privacy.ts:26

Parameters ​
ParameterType
inputPagedReadInput
Returns ​

Promise<Record<string, unknown>[]>

selectByIds() ​
ts
selectByIds(
   ids,
   tenantId,
fields?): Promise<Record<string, unknown>[]>;

Defined in: src/jobs/paged-privacy.ts:27

Parameters ​
ParameterType
idsPagedId[]
tenantIdstring
fields?string[]
Returns ​

Promise<Record<string, unknown>[]>

updateByIds() ​
ts
updateByIds(
   ids,
   tenantId,
replacements): Promise<number>;

Defined in: src/jobs/paged-privacy.ts:29

Parameters ​
ParameterType
idsPagedId[]
tenantIdstring
replacementsRecord<string, unknown>
Returns ​

Promise<number>


PagedFromPrismaOptions ​

Defined in: src/prisma/paged-from-prisma.ts:15

Properties ​

delegate ​
ts
delegate: PagedPrismaDelegate;

Defined in: src/prisma/paged-from-prisma.ts:16

singleTenantId? ​
ts
optional singleTenantId?: string;

Defined in: src/prisma/paged-from-prisma.ts:19

stableIdField? ​
ts
optional stableIdField?: string;

Defined in: src/prisma/paged-from-prisma.ts:21

A unique immutable string or safe-integer Prisma scalar key.

subjectField ​
ts
subjectField: string;

Defined in: src/prisma/paged-from-prisma.ts:17

tenantField? ​
ts
optional tenantField?: string;

Defined in: src/prisma/paged-from-prisma.ts:18


PagedPrismaDelegate ​

Defined in: src/prisma/paged-from-prisma.ts:4

Methods ​

deleteMany() ​
ts
deleteMany(args): Promise<{
  count: number;
}>;

Defined in: src/prisma/paged-from-prisma.ts:11

Parameters ​
ParameterType
args{ where: Record<string, unknown>; }
args.whereRecord<string, unknown>
Returns ​

Promise<{ count: number; }>

findMany() ​
ts
findMany(args): Promise<Record<string, unknown>[]>;

Defined in: src/prisma/paged-from-prisma.ts:5

Parameters ​
ParameterType
args{ orderBy?: Record<string, "asc" | "desc">; select?: Record<string, boolean>; take: number; where: Record<string, unknown>; }
args.orderBy?Record<string, "asc" | "desc">
args.select?Record<string, boolean>
args.takenumber
args.whereRecord<string, unknown>
Returns ​

Promise<Record<string, unknown>[]>

updateMany() ​
ts
updateMany(args): Promise<{
  count: number;
}>;

Defined in: src/prisma/paged-from-prisma.ts:12

Parameters ​
ParameterType
args{ data: Record<string, unknown>; where: Record<string, unknown>; }
args.dataRecord<string, unknown>
args.whereRecord<string, unknown>
Returns ​

Promise<{ count: number; }>


PagedPrivacyOptions ​

Defined in: src/jobs/paged-privacy.ts:40

Properties ​

batchSize? ​
ts
optional batchSize?: number;

Defined in: src/jobs/paged-privacy.ts:46

excludedModels? ​
ts
optional excludedModels?: Record<string, string>;

Defined in: src/jobs/paged-privacy.ts:44

Unregistered models reviewed as out of scope; relation checks still inspect them.

executors ​
ts
executors: Record<string, PagedEntityExecutor>;

Defined in: src/jobs/paged-privacy.ts:45

maxChunkBytes? ​
ts
optional maxChunkBytes?: number;

Defined in: src/jobs/paged-privacy.ts:47

registry ​
ts
registry: Registry;

Defined in: src/jobs/paged-privacy.ts:41

schemaSource ​
ts
schemaSource: string;

Defined in: src/jobs/paged-privacy.ts:42


PagedPrivacyPayload ​

Defined in: src/jobs/paged-privacy.ts:33

Properties ​

policyHash ​
ts
policyHash: string;

Defined in: src/jobs/paged-privacy.ts:37

schemaVersion ​
ts
schemaVersion: "data-subject.paged-privacy.v1";

Defined in: src/jobs/paged-privacy.ts:34

subjectId ​
ts
subjectId: string;

Defined in: src/jobs/paged-privacy.ts:36

type ​
ts
type: "export" | "erase";

Defined in: src/jobs/paged-privacy.ts:35


PagedReadInput ​

Defined in: src/jobs/paged-privacy.ts:13

Properties ​

after? ​
ts
optional after?: PagedId;

Defined in: src/jobs/paged-privacy.ts:16

fields? ​
ts
optional fields?: string[];

Defined in: src/jobs/paged-privacy.ts:19

limit ​
ts
limit: number;

Defined in: src/jobs/paged-privacy.ts:18

subjectId ​
ts
subjectId: string;

Defined in: src/jobs/paged-privacy.ts:14

tenantId ​
ts
tenantId: string;

Defined in: src/jobs/paged-privacy.ts:15

through ​
ts
through: PagedId;

Defined in: src/jobs/paged-privacy.ts:17


PolicySpec ​

Defined in: src/policy-compiler.ts:9

Extended by ​

Properties ​

dependsOn? ​
ts
optional dependsOn?: string[];

Defined in: src/policy-compiler.ts:19

Parent entities: this entity is erased before each named parent.

entityName ​
ts
entityName: string;

Defined in: src/policy-compiler.ts:10

exportFields? ​
ts
optional exportFields?: string[];

Defined in: src/policy-compiler.ts:15

Explicit top-level export allowlist. Omit for an erase-only entity.

fields ​
ts
fields: Record<string, PolicyEntry>;

Defined in: src/policy-compiler.ts:13

rowLevel? ​
ts
optional rowLevel?: "delete-row" | "delete-fields";

Defined in: src/policy-compiler.ts:12

stableIdField? ​
ts
optional stableIdField?: string;

Defined in: src/policy-compiler.ts:17

Immutable row identity used for post-write verification.

subjectField ​
ts
subjectField: string;

Defined in: src/policy-compiler.ts:11


PostgresJobClient ​

Defined in: src/jobs/postgres-job-store.ts:12

Extends ​

Type Parameters ​

Type Parameter
TTransaction extends PostgresJobTransactionClient

Methods ​

$queryRawUnsafe() ​
ts
$queryRawUnsafe(query, ...values): Promise<unknown>;

Defined in: src/jobs/postgres-job-store.ts:9

Parameters ​
ParameterType
querystring
...valuesunknown[]
Returns ​

Promise<unknown>

Inherited from ​

PostgresJobTransactionClient.$queryRawUnsafe

$transaction() ​
ts
$transaction<T>(work, options?): Promise<T>;

Defined in: src/jobs/postgres-job-store.ts:14

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
work(transaction) => Promise<T>
options?{ isolationLevel?: "Serializable"; maxWait?: number; timeout?: number; }
options.isolationLevel?"Serializable"
options.maxWait?number
options.timeout?number
Returns ​

Promise<T>


PostgresJobStoreOptions ​

Defined in: src/jobs/postgres-job-store.ts:20

Type Parameters ​

Type Parameter
TTransaction extends PostgresJobTransactionClient

Properties ​

chunkTableName? ​
ts
optional chunkTableName?: string;

Defined in: src/jobs/postgres-job-store.ts:25

client ​
ts
client: PostgresJobClient<TTransaction>;

Defined in: src/jobs/postgres-job-store.ts:21

maxAttempts? ​
ts
optional maxAttempts?: number;

Defined in: src/jobs/postgres-job-store.ts:29

maxChunkBytes? ​
ts
optional maxChunkBytes?: number;

Defined in: src/jobs/postgres-job-store.ts:31

maxJsonBytes? ​
ts
optional maxJsonBytes?: number;

Defined in: src/jobs/postgres-job-store.ts:32

retentionMs? ​
ts
optional retentionMs?: number;

Defined in: src/jobs/postgres-job-store.ts:34

Immutable retention deadline for queued/terminal payloads and chunks; default seven days.

retryDelayMs? ​
ts
optional retryDelayMs?: number;

Defined in: src/jobs/postgres-job-store.ts:30

schemaName? ​
ts
optional schemaName?: string;

Defined in: src/jobs/postgres-job-store.ts:26

serializationAttempts? ​
ts
optional serializationAttempts?: number;

Defined in: src/jobs/postgres-job-store.ts:28

tableName? ​
ts
optional tableName?: string;

Defined in: src/jobs/postgres-job-store.ts:24

transactionOptions? ​
ts
optional transactionOptions?: {
  maxWait?: number;
  timeout?: number;
};

Defined in: src/jobs/postgres-job-store.ts:27

maxWait? ​
ts
optional maxWait?: number;
timeout? ​
ts
optional timeout?: number;

Methods ​

bindTransaction() ​
ts
bindTransaction<T>(transaction, work): Promise<T>;

Defined in: src/jobs/postgres-job-store.ts:23

Route every local business delegate to this transaction, e.g. through AsyncLocalStorage.

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
transactionTTransaction
work() => Promise<T>
Returns ​

Promise<T>


PostgresJobTransactionClient ​

Defined in: src/jobs/postgres-job-store.ts:8

Extended by ​

Methods ​

$queryRawUnsafe() ​
ts
$queryRawUnsafe(query, ...values): Promise<unknown>;

Defined in: src/jobs/postgres-job-store.ts:9

Parameters ​
ParameterType
querystring
...valuesunknown[]
Returns ​

Promise<unknown>


PrismaDataSubjectRequestDelegate ​

Defined in: src/storage/prisma-request-storage.ts:12

Methods ​

create() ​
ts
create(args): Promise<unknown>;

Defined in: src/storage/prisma-request-storage.ts:13

Parameters ​
ParameterType
args{ data: Record<string, unknown>; }
args.dataRecord<string, unknown>
Returns ​

Promise<unknown>

findMany() ​
ts
findMany(args): Promise<unknown[]>;

Defined in: src/storage/prisma-request-storage.ts:21

Parameters ​
ParameterType
args{ orderBy?: { createdAt?: "asc" | "desc"; dueAt?: "asc" | "desc"; }; where?: { dueAt?: { lt: Date; }; state?: | RequestState | { in: RequestState[]; }; tenantId?: string; }; }
args.orderBy?{ createdAt?: "asc" | "desc"; dueAt?: "asc" | "desc"; }
args.orderBy.createdAt?"asc" | "desc"
args.orderBy.dueAt?"asc" | "desc"
args.where?{ dueAt?: { lt: Date; }; state?: | RequestState | { in: RequestState[]; }; tenantId?: string; }
args.where.dueAt?{ lt: Date; }
args.where.dueAt.ltDate
args.where.state?| RequestState | { in: RequestState[]; }
args.where.tenantId?string
Returns ​

Promise<unknown[]>

findUnique() ​
ts
findUnique(args): Promise<unknown>;

Defined in: src/storage/prisma-request-storage.ts:18

Parameters ​
ParameterType
args{ where: { id: string; tenantId: string; }; }
args.where{ id: string; tenantId: string; }
args.where.idstring
args.where.tenantIdstring
Returns ​

Promise<unknown>

update() ​
ts
update(args): Promise<unknown>;

Defined in: src/storage/prisma-request-storage.ts:14

Parameters ​
ParameterType
args{ data: Record<string, unknown>; where: { id: string; tenantId: string; }; }
args.dataRecord<string, unknown>
args.where{ id: string; tenantId: string; }
args.where.idstring
args.where.tenantIdstring
Returns ​

Promise<unknown>


PrismaDelegate ​

Defined in: src/prisma/from-prisma.ts:4

Methods ​

deleteMany() ​
ts
deleteMany(args): Promise<{
  count: number;
}>;

Defined in: src/prisma/from-prisma.ts:8

Parameters ​
ParameterType
args{ where: Record<string, unknown>; }
args.whereRecord<string, unknown>
Returns ​

Promise<{ count: number; }>

findMany() ​
ts
findMany(args): Promise<Record<string, unknown>[]>;

Defined in: src/prisma/from-prisma.ts:5

Parameters ​
ParameterType
args{ where: Record<string, unknown>; }
args.whereRecord<string, unknown>
Returns ​

Promise<Record<string, unknown>[]>

updateMany() ​
ts
updateMany(args): Promise<{
  count: number;
}>;

Defined in: src/prisma/from-prisma.ts:11

Parameters ​
ParameterType
args{ data: Record<string, unknown>; where: Record<string, unknown>; }
args.dataRecord<string, unknown>
args.whereRecord<string, unknown>
Returns ​

Promise<{ count: number; }>


PrismaExecutionClient ​

Defined in: src/storage/prisma-execution-store.ts:43

Type Parameters ​

Type Parameter
TTransaction extends PrismaExecutionTransactionClient

Properties ​

dataSubjectExecution ​
ts
dataSubjectExecution: PrismaExecutionDelegate;

Defined in: src/storage/prisma-execution-store.ts:45

dataSubjectRequest ​
ts
dataSubjectRequest: PrismaDataSubjectRequestDelegate;

Defined in: src/storage/prisma-execution-store.ts:44

Methods ​

$transaction() ​
ts
$transaction<T>(work, options?): Promise<T>;

Defined in: src/storage/prisma-execution-store.ts:46

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
work(transaction) => Promise<T>
options?{ isolationLevel?: "Serializable"; maxWait?: number; timeout?: number; }
options.isolationLevel?"Serializable"
options.maxWait?number
options.timeout?number
Returns ​

Promise<T>


PrismaExecutionStoreOptions ​

Defined in: src/storage/prisma-execution-store.ts:52

Type Parameters ​

Type Parameter
TTransaction extends PrismaExecutionTransactionClient

Properties ​

client ​
ts
client: PrismaExecutionClient<TTransaction>;

Defined in: src/storage/prisma-execution-store.ts:53

executionSchemaName? ​
ts
optional executionSchemaName?: string;

Defined in: src/storage/prisma-execution-store.ts:63

Set this when the model is outside the connection's default SQL search_path.

executionTableName? ​
ts
optional executionTableName?: string;

Defined in: src/storage/prisma-execution-store.ts:61

SQL table name when the Prisma model uses @@map. Schema-qualified names are not accepted.

serializationAttempts? ​
ts
optional serializationAttempts?: number;

Defined in: src/storage/prisma-execution-store.ts:59

Known PostgreSQL serialization aborts only; default 8 total attempts with bounded backoff.

transactionOptions? ​
ts
optional transactionOptions?: {
  maxWait?: number;
  timeout?: number;
};

Defined in: src/storage/prisma-execution-store.ts:57

Increase timeout deliberately for bounded upload/delivery work; never run unbounded jobs.

maxWait? ​
ts
optional maxWait?: number;
timeout? ​
ts
optional timeout?: number;

Methods ​

bindTransaction() ​
ts
bindTransaction<T>(transaction, work): Promise<T>;

Defined in: src/storage/prisma-execution-store.ts:55

Required: route every executor to this transaction (for example with AsyncLocalStorage).

Type Parameters ​
Type Parameter
T
Parameters ​
ParameterType
transactionTTransaction
work() => Promise<T>
Returns ​

Promise<T>


PrismaExecutionTransactionClient ​

Defined in: src/storage/prisma-execution-store.ts:37

Properties ​

dataSubjectExecution ​
ts
dataSubjectExecution: PrismaExecutionDelegate;

Defined in: src/storage/prisma-execution-store.ts:39

dataSubjectRequest ​
ts
dataSubjectRequest: PrismaDataSubjectRequestDelegate;

Defined in: src/storage/prisma-execution-store.ts:38

Methods ​

$queryRawUnsafe() ​
ts
$queryRawUnsafe(query, ...values): Promise<unknown>;

Defined in: src/storage/prisma-execution-store.ts:40

Parameters ​
ParameterType
querystring
...valuesunknown[]
Returns ​

Promise<unknown>


PrismaRequestStorageOptions ​

Defined in: src/storage/prisma-request-storage.ts:31

Properties ​

delegate ​
ts
delegate: PrismaDataSubjectRequestDelegate;

Defined in: src/storage/prisma-request-storage.ts:32


RegisteredEntity ​

Defined in: src/types.ts:49

Properties ​

executor ​
ts
executor: EntityExecutor;

Defined in: src/types.ts:51

policy ​
ts
policy: EntityPolicy;

Defined in: src/types.ts:50


RegisterInput ​

Defined in: src/registry.ts:6

Properties ​

executor ​
ts
executor: EntityExecutor;

Defined in: src/registry.ts:8

policy ​
ts
policy: PolicySpec;

Defined in: src/registry.ts:7


RegistryValidationOptions ​

Defined in: src/registry-validation.ts:6

Properties ​

requireTenantField? ​
ts
optional requireTenantField?: boolean;

Defined in: src/registry-validation.ts:7

schemaSource? ​
ts
optional schemaSource?: string;

Defined in: src/registry-validation.ts:9

Schema validation requires every entity to use registerDefinition.

strictCoverage? ​
ts
optional strictCoverage?: boolean;

Defined in: src/registry-validation.ts:10

suppressions? ​
ts
optional suppressions?: DataSubjectLintSuppression[];

Defined in: src/registry-validation.ts:12

Explicit reviewed exclusions; relation checks still inspect the full schema.


RegistryValidationReport ​

Defined in: src/registry-validation.ts:15

Properties ​

findings ​
ts
findings: DataSubjectLintFinding[];

Defined in: src/registry-validation.ts:17

ok ​
ts
ok: boolean;

Defined in: src/registry-validation.ts:16


RequestContext ​

Defined in: src/data-subject.service.ts:26

Properties ​

preview? ​
ts
optional preview?: ErasurePreview;

Defined in: src/data-subject.service.ts:30

requestedBy? ​
ts
optional requestedBy?: string;

Defined in: src/data-subject.service.ts:28

The host must authenticate this actor and authorize the verified subject first.

requestKey? ​
ts
optional requestKey?: string;

Defined in: src/data-subject.service.ts:29


RequestLifecycle ​

Defined in: src/types.ts:108

Properties ​

artifactFailure? ​
ts
optional artifactFailure?: {
  code: string;
  recovery: "retry_artifact" | "artifact_expired";
};

Defined in: src/types.ts:109

code ​
ts
code: string;
recovery ​
ts
recovery: "retry_artifact" | "artifact_expired";

dataOutcome ​
ts
dataOutcome: "completed" | "not_started" | "unknown";

Defined in: src/types.ts:110

failureStage? ​
ts
optional failureStage?: FailureStage;

Defined in: src/types.ts:111

notificationFailures? ​
ts
optional notificationFailures?: {
  channel: "outbox" | "audit";
  code: string;
  event: string;
  recovery: "retry_notification";
}[];

Defined in: src/types.ts:119

Callback delivery failures never undo completed data processing.

channel ​
ts
channel: "outbox" | "audit";
code ​
ts
code: string;
event ​
ts
event: string;
recovery ​
ts
recovery: "retry_notification";

recovery? ​
ts
optional recovery?:
  | "retry_artifact"
  | "artifact_expired"
  | "retry_request"
  | "inspect_data"
  | "reconcile_request";

Defined in: src/types.ts:112


RequestStats ​

Defined in: src/types.ts:74

Properties ​

entities ​
ts
entities: {
  affected: number;
  entityName: string;
  strategy: RequestEntityStrategy;
}[];

Defined in: src/types.ts:79

affected ​
ts
affected: number;
entityName ​
ts
entityName: string;
strategy ​
ts
strategy: RequestEntityStrategy;

evidence? ​
ts
optional evidence?: {
  artifactHash: string;
  artifactUrl: string;
  schemaVersion: "data-subject.evidence.v1" | "data-subject.evidence.v2";
};

Defined in: src/types.ts:94

artifactHash ​
ts
artifactHash: string;
artifactUrl ​
ts
artifactUrl: string;
schemaVersion ​
ts
schemaVersion: "data-subject.evidence.v1" | "data-subject.evidence.v2";

lifecycle? ​
ts
optional lifecycle?: RequestLifecycle;

Defined in: src/types.ts:78

Stored in the existing stats JSON column; no schema migration is required.

policyHash? ​
ts
optional policyHash?: string;

Defined in: src/types.ts:75

postScan? ​
ts
optional postScan?: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:93

count ​
ts
count: number;
entityName ​
ts
entityName: string;

preScan? ​
ts
optional preScan?: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:92

count ​
ts
count: number;
entityName ​
ts
entityName: string;

retained? ​
ts
optional retained?: {
  count: number;
  entityName: string;
  field: string;
  legalBasis: string;
  until?: string;
}[];

Defined in: src/types.ts:84

count ​
ts
count: number;
entityName ​
ts
entityName: string;
field ​
ts
field: string;
legalBasis ​
ts
legalBasis: string;
until? ​
ts
optional until?: string;

verification? ​
ts
optional verification?: {
  entityName: string;
} & EntityVerification[];

Defined in: src/types.ts:76

verificationResidual? ​
ts
optional verificationResidual?: {
  count: number;
  entityName: string;
}[];

Defined in: src/types.ts:91

count ​
ts
count: number;
entityName ​
ts
entityName: string;

RequestStorage ​

Defined in: src/storage/request-storage.interface.ts:3

Methods ​

findById() ​
ts
findById(id, tenantId): Promise<DataSubjectRequest | null>;

Defined in: src/storage/request-storage.interface.ts:12

A request outside the supplied tenant is indistinguishable from a missing request.

Parameters ​
ParameterType
idstring
tenantIdstring
Returns ​

Promise<DataSubjectRequest | null>

insert() ​
ts
insert(req): Promise<void>;

Defined in: src/storage/request-storage.interface.ts:4

Parameters ​
ParameterType
reqDataSubjectRequest
Returns ​

Promise<void>

listByTenant() ​
ts
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;

Defined in: src/storage/request-storage.interface.ts:13

Parameters ​
ParameterType
tenantIdstring
opts?{ state?: RequestState; }
opts.state?RequestState
Returns ​

Promise<DataSubjectRequest[]>

listOverdue() ​
ts
listOverdue(now): Promise<DataSubjectRequest[]>;

Defined in: src/storage/request-storage.interface.ts:17

Parameters ​
ParameterType
nowDate
Returns ​

Promise<DataSubjectRequest[]>

update() ​
ts
update(
   id,
   tenantId,
patch): Promise<void>;

Defined in: src/storage/request-storage.interface.ts:6

Update within a tenant; request identity fields are immutable.

Parameters ​
ParameterType
idstring
tenantIdstring
patchPartial<DataSubjectRequest>
Returns ​

Promise<void>


TranscendAdapterOptions ​

Defined in: src/integrations/transcend.ts:65

Properties ​

bindings ​
ts
bindings: readonly TranscendBinding[];

Defined in: src/integrations/transcend.ts:66

callbackTimeoutMs? ​
ts
optional callbackTimeoutMs?: number;

Defined in: src/integrations/transcend.ts:72

clock? ​
ts
optional clock?: () => Date;

Defined in: src/integrations/transcend.ts:71

Returns ​

Date

http? ​
ts
optional http?: (request) => Promise<{
  status: number;
}>;

Defined in: src/integrations/transcend.ts:74

A trusted transport override for tests/proxies; it must honor redirect and abort.

Parameters ​
ParameterType
requestTranscendHttpRequest
Returns ​

Promise<{ status: number; }>

jobs ​
ts
jobs: Pick<DurableJobStore, "submit" | "get">;

Defined in: src/integrations/transcend.ts:67

nonceEncryptionKey ​
ts
nonceEncryptionKey: Buffer;

Defined in: src/integrations/transcend.ts:70

Keep this stable across workers/restarts. Rotate only after draining old jobs.

service ​
ts
service: Pick<DataSubjectService, "erase" | "getRequest" | "retryCompletion">;

Defined in: src/integrations/transcend.ts:68


TranscendBinding ​

Defined in: src/integrations/transcend.ts:35

Properties ​

allowTestRequests? ​
ts
optional allowTestRequests?: boolean;

Defined in: src/integrations/transcend.ts:52

Test webhooks are rejected unless explicitly routed to this test binding.

apiKey ​
ts
apiKey: string;

Defined in: src/integrations/transcend.ts:47

audience ​
ts
audience: string;

Defined in: src/integrations/transcend.ts:41

dataSiloId ​
ts
dataSiloId: string;

Defined in: src/integrations/transcend.ts:39

dataSubjectType ​
ts
dataSubjectType: string;

Defined in: src/integrations/transcend.ts:50

id ​
ts
id: string;

Defined in: src/integrations/transcend.ts:37

Stable operator-selected identity; never choose a tenant from the webhook body.

identifierType ​
ts
identifierType: string;

Defined in: src/integrations/transcend.ts:49

organizationId ​
ts
organizationId: string;

Defined in: src/integrations/transcend.ts:38

publicKeys ​
ts
publicKeys: readonly string[];

Defined in: src/integrations/transcend.ts:42

sombraApiKey? ​
ts
optional sombraApiKey?: string;

Defined in: src/integrations/transcend.ts:48

sombraOrigin ​
ts
sombraOrigin: string;

Defined in: src/integrations/transcend.ts:46

Operator-configured HTTPS origin, without path/query/userinfo.

tenantId ​
ts
tenantId: string;

Defined in: src/integrations/transcend.ts:40

webhookSecret ​
ts
webhookSecret: string;

Defined in: src/integrations/transcend.ts:44

Set this as a custom x-data-subject-webhook-secret header in Transcend.

Methods ​

resolveSubject() ​
ts
resolveSubject(identifier): Promise<string | null>;

Defined in: src/integrations/transcend.ts:53

Parameters ​
ParameterType
identifierstring
Returns ​

Promise<string | null>


TranscendHttpRequest ​

Defined in: src/integrations/transcend.ts:56

Properties ​

body ​
ts
body: string;

Defined in: src/integrations/transcend.ts:60

headers ​
ts
headers: Record<string, string>;

Defined in: src/integrations/transcend.ts:59

method ​
ts
method: "PUT";

Defined in: src/integrations/transcend.ts:58

redirect ​
ts
redirect: "error";

Defined in: src/integrations/transcend.ts:61

signal ​
ts
signal: AbortSignal;

Defined in: src/integrations/transcend.ts:62

url ​
ts
url: string;

Defined in: src/integrations/transcend.ts:57

Type Aliases ​

DataSubjectErrorCode ​

ts
type DataSubjectErrorCode = typeof DataSubjectErrorCode[keyof typeof DataSubjectErrorCode];

Defined in: src/errors.ts:3


DataSubjectOutboxEvent ​

ts
type DataSubjectOutboxEvent =
  | {
  payload: {
     requestId: string;
     requestType: RequestType;
     tenantId: string;
  };
  type: "data_subject.artifact_expired";
}
  | {
  payload: {
     requestId: string;
     requestType: RequestType;
     subjectId: string;
     tenantId: string;
  };
  type: "data_subject.request_created";
}
  | {
  payload: {
     requestedAt: string;
     requestId: string;
     subjectId: string;
     tenantId: string;
  };
  type: "data_subject.erasure_requested";
}
  | {
  payload: {
     artifactHash: string;
     requestId: string;
     requestType: RequestType;
     state: "completed";
     tenantId: string;
  };
  type: "data_subject.request_completed";
}
  | {
  payload: {
     dataOutcome: RequestLifecycle["dataOutcome"];
     failureReason: string;
     failureStage: FailureStage;
     recovery: NonNullable<RequestLifecycle["recovery"]>;
     requestId: string;
     requestType: RequestType;
     tenantId: string;
  };
  type: "data_subject.request_failed";
};

Defined in: src/types.ts:172


FailureStage ​

ts
type FailureStage =
  | "request_created"
  | "processing"
  | "data_execution"
  | "artifact_write"
  | "completion_persistence";

Defined in: src/types.ts:101


JobHandler ​

ts
type JobHandler = (transaction) => Promise<JobStepResult>;

Defined in: src/jobs/types.ts:54

Parameters ​

ParameterType
transactionJobTransaction

Returns ​

Promise<JobStepResult>


JobJson ​

ts
type JobJson =
  | null
  | boolean
  | number
  | string
  | JobJson[]
  | {
[key: string]: JobJson;
};

Defined in: src/jobs/types.ts:2

Queue payloads and checkpoints must be plain JSON; never put credentials in them.


PagedId ​

ts
type PagedId = string | number;

Defined in: src/jobs/paged-privacy.ts:12


PolicyEntry ​

ts
type PolicyEntry =
  | "delete"
  | {
  strategy: "delete";
}
  | {
  replacement: string | number | null;
  strategy: "anonymize";
}
  | {
  legalBasis: string;
  pseudonymize?: "hmac" | "none";
  strategy: "retain";
  until?: string;
};

Defined in: src/types.ts:5


RequestEntityStrategy ​

ts
type RequestEntityStrategy = Strategy | "mixed" | "export";

Defined in: src/types.ts:2


RequestState ​

ts
type RequestState = "created" | "validating" | "processing" | "completed" | "failed";

Defined in: src/types.ts:55


RequestType ​

ts
type RequestType = "export" | "erase";

Defined in: src/types.ts:54


RowLevel ​

ts
type RowLevel = "delete-row" | "delete-fields";

Defined in: src/types.ts:3


Strategy ​

ts
type Strategy = "delete" | "anonymize" | "retain";

Defined in: src/types.ts:1


TenantScope ​

ts
type TenantScope =
  | {
  mode: "multi-tenant";
  tenantField: string;
}
  | {
  mode: "single-tenant";
  tenantId: string;
};

Defined in: src/types.ts:31

Variables ​

DATA_SUBJECT_REGISTRY ​

ts
const DATA_SUBJECT_REGISTRY: typeof DATA_SUBJECT_REGISTRY;

Defined in: src/data-subject.module.ts:10


DataSubjectErrorCode ​

ts
const DataSubjectErrorCode: {
  AnonymizeDynamicReplacement: "dsr_anonymize_dynamic_replacement";
  ArtifactExpired: "dsr_artifact_expired";
  ArtifactWriteFailed: "dsr_artifact_write_failed";
  DurableExecutionRequired: "dsr_durable_execution_required";
  EntityAlreadyRegistered: "dsr_entity_already_registered";
  EvidenceReportInvalid: "dsr_evidence_report_invalid";
  InvalidInput: "dsr_invalid_input";
  InvalidPolicy: "dsr_invalid_policy";
  InvalidScope: "dsr_invalid_scope";
  InvalidStateTransition: "dsr_invalid_state_transition";
  PlanExpired: "dsr_plan_expired";
  PlanMismatch: "dsr_plan_mismatch";
  RequestConflict: "dsr_request_conflict";
  RequestNotFound: "dsr_request_not_found";
  RequestPersistenceFailed: "dsr_request_persistence_failed";
  SubjectNotFound: "dsr_subject_not_found";
  UnregisteredEntity: "dsr_unregistered_entity";
  VerificationFailed: "dsr_verification_failed";
  VerificationUnavailable: "dsr_verification_unavailable";
};

Defined in: src/errors.ts:3

Type Declaration ​

NameTypeDefault valueDefined in
AnonymizeDynamicReplacement"dsr_anonymize_dynamic_replacement"'dsr_anonymize_dynamic_replacement'src/errors.ts:8
ArtifactExpired"dsr_artifact_expired"'dsr_artifact_expired'src/errors.ts:13
ArtifactWriteFailed"dsr_artifact_write_failed"'dsr_artifact_write_failed'src/errors.ts:12
DurableExecutionRequired"dsr_durable_execution_required"'dsr_durable_execution_required'src/errors.ts:22
EntityAlreadyRegistered"dsr_entity_already_registered"'dsr_entity_already_registered'src/errors.ts:9
EvidenceReportInvalid"dsr_evidence_report_invalid"'dsr_evidence_report_invalid'src/errors.ts:15
InvalidInput"dsr_invalid_input"'dsr_invalid_input'src/errors.ts:16
InvalidPolicy"dsr_invalid_policy"'dsr_invalid_policy'src/errors.ts:6
InvalidScope"dsr_invalid_scope"'dsr_invalid_scope'src/errors.ts:17
InvalidStateTransition"dsr_invalid_state_transition"'dsr_invalid_state_transition'src/errors.ts:14
PlanExpired"dsr_plan_expired"'dsr_plan_expired'src/errors.ts:20
PlanMismatch"dsr_plan_mismatch"'dsr_plan_mismatch'src/errors.ts:19
RequestConflict"dsr_request_conflict"'dsr_request_conflict'src/errors.ts:10
RequestNotFound"dsr_request_not_found"'dsr_request_not_found'src/errors.ts:11
RequestPersistenceFailed"dsr_request_persistence_failed"'dsr_request_persistence_failed'src/errors.ts:18
SubjectNotFound"dsr_subject_not_found"'dsr_subject_not_found'src/errors.ts:4
UnregisteredEntity"dsr_unregistered_entity"'dsr_unregistered_entity'src/errors.ts:5
VerificationFailed"dsr_verification_failed"'dsr_verification_failed'src/errors.ts:7
VerificationUnavailable"dsr_verification_unavailable"'dsr_verification_unavailable'src/errors.ts:21

PAGED_PRIVACY_JOB_KIND ​

ts
const PAGED_PRIVACY_JOB_KIND: "data-subject.privacy" = 'data-subject.privacy';

Defined in: src/jobs/paged-privacy.ts:32


TRANSCEND_ERASURE_JOB ​

ts
const TRANSCEND_ERASURE_JOB: "transcend-erasure" = 'transcend-erasure';

Defined in: src/integrations/transcend.ts:33

Functions ​

buildErasureEvidenceArtifact() ​

ts
function buildErasureEvidenceArtifact(input): ErasureEvidenceArtifact;

Defined in: src/erasure-evidence.ts:18

Parameters ​

ParameterType
inputBuildErasureEvidenceInput

Returns ​

ErasureEvidenceArtifact


compilePolicy() ​

ts
function compilePolicy(spec, opts?): EntityPolicy;

Defined in: src/policy-compiler.ts:22

Parameters ​

ParameterType
specPolicySpec
optsCompileOptions

Returns ​

EntityPolicy


createPagedPrivacyHandler() ​

ts
function createPagedPrivacyHandler(options): JobHandler;

Defined in: src/jobs/paged-privacy.ts:75

Bounded privacy processing for independent, relation-free models only. Upper bounds are fixed for every entity in the first transaction; this is not a cross-page DB snapshot. Inserts below a bound and updates after a page commits can change the scope. Cancellation never undoes an already committed page.

Parameters ​

ParameterType
optionsPagedPrivacyOptions

Returns ​

JobHandler


createPagedPrivacyPayload() ​

ts
function createPagedPrivacyPayload(input): PagedPrivacyPayload & {
[key: string]: JobJson;
};

Defined in: src/jobs/paged-privacy.ts:62

Parameters ​

ParameterType
input{ registry: Registry; subjectId: string; type: "export" | "erase"; }
input.registryRegistry
input.subjectIdstring
input.type"export" | "erase"

Returns ​

PagedPrivacyPayload & { [key: string]: JobJson; }


definePolicy() ​

ts
function definePolicy(definitions): EntityDefinition[];

Defined in: src/policy-definition.ts:14

Parameters ​

ParameterType
definitionsreadonly EntityDefinition[]

Returns ​

EntityDefinition[]


erasureEvidenceArtifactKey() ​

ts
function erasureEvidenceArtifactKey(tenantId, requestId): string;

Defined in: src/artifacts.ts:11

Parameters ​

ParameterType
tenantIdstring
requestIdstring

Returns ​

string


exportArtifactKey() ​

ts
function exportArtifactKey(tenantId, requestId): string;

Defined in: src/artifacts.ts:7

Parameters ​

ParameterType
tenantIdstring
requestIdstring

Returns ​

string


formatLintReport() ​

ts
function formatLintReport(report): string;

Defined in: src/lint/lint.ts:454

Parameters ​

ParameterType
reportDataSubjectLintReport

Returns ​

string


fromPrisma() ​

ts
function fromPrisma(opts): EntityExecutor;

Defined in: src/prisma/from-prisma.ts:27

Parameters ​

ParameterType
optsFromPrismaOptions

Returns ​

EntityExecutor


hashRegistryPolicy() ​

ts
function hashRegistryPolicy(registry): string;

Defined in: src/erasure-plan.ts:82

Parameters ​

ParameterType
registryRegistry

Returns ​

string


lintPrismaSchema() ​

ts
function lintPrismaSchema(schemaSource, config?): DataSubjectLintReport;

Defined in: src/lint/lint.ts:25

Parameters ​

ParameterType
schemaSourcestring
configDataSubjectLintConfig

Returns ​

DataSubjectLintReport


pagedFromPrisma() ​

ts
function pagedFromPrisma(options): PagedEntityExecutor;

Defined in: src/prisma/paged-from-prisma.ts:27

Every read and write is bounded by a page or a finite set of stable row IDs.

Parameters ​

ParameterType
optionsPagedFromPrismaOptions

Returns ​

PagedEntityExecutor


parsePrismaSchema() ​

ts
function parsePrismaSchema(source): PrismaSchemaModel[];

Defined in: src/lint/prisma-schema.ts:57

A deliberately limited, line-oriented parser. Unsupported syntax must fail lint closed.

Parameters ​

ParameterType
sourcestring

Returns ​

PrismaSchemaModel[]


sha256Hex() ​

ts
function sha256Hex(body): string;

Defined in: src/artifacts.ts:3

Parameters ​

ParameterType
bodystring | Buffer<ArrayBufferLike>

Returns ​

string


shouldFailLint() ​

ts
function shouldFailLint(report, failOn): boolean;

Defined in: src/lint/lint.ts:463

Parameters ​

ParameterType
reportDataSubjectLintReport
failOnDataSubjectLintSeverity

Returns ​

boolean


validateDefinition() ​

ts
function validateDefinition(definition): void;

Defined in: src/policy-definition.ts:36

Parameters ​

ParameterType
definitionEntityDefinition

Returns ​

void


validateLegalBasis() ​

ts
function validateLegalBasis(value, opts?): string | null;

Defined in: src/legal-basis.ts:7

Parameters ​

ParameterType
valuestring
optsLegalBasisOptions

Returns ​

string | null


validateRegistry() ​

ts
function validateRegistry(registry, opts?): RegistryValidationReport;

Defined in: src/registry-validation.ts:20

Parameters ​

ParameterType
registryRegistry
optsRegistryValidationOptions

Returns ​

RegistryValidationReport

References ​

DataSubjectLintCode ​

Re-exports DataSubjectLintCode


DataSubjectLintConfig ​

Re-exports DataSubjectLintConfig


DataSubjectLintFinding ​

Re-exports DataSubjectLintFinding


DataSubjectLintRegistryEntry ​

Re-exports DataSubjectLintRegistryEntry


DataSubjectLintReport ​

Re-exports DataSubjectLintReport


DataSubjectLintSeverity ​

Re-exports DataSubjectLintSeverity


DataSubjectLintSuppression ​

Re-exports DataSubjectLintSuppression

Documentation site: MIT License. Check each package for its license.