@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
new DataSubjectError(code, reason?): DataSubjectError;Defined in: src/errors.ts:53
Parameters
| Parameter | Type |
|---|---|
code | DataSubjectErrorCode |
reason? | string |
Returns
Overrides
Error.constructorProperties
cause?
optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.causecode
readonly code: DataSubjectErrorCode;Defined in: src/errors.ts:50
httpStatus
readonly httpStatus: number;Defined in: src/errors.ts:51
message
message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.messagename
name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.namestack?
optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stackstackTraceLimit
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
Error.stackTraceLimitMethods
captureStackTrace()
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.
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:
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
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTraceprepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:56
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTraceDataSubjectModule
Defined in: src/data-subject.module.ts:31
Constructors
Constructor
new DataSubjectModule(): DataSubjectModule;Returns
Methods
forRoot()
static forRoot(options): DynamicModule;Defined in: src/data-subject.module.ts:32
Parameters
| Parameter | Type |
|---|---|
options | DataSubjectModuleOptions |
Returns
DynamicModule
DataSubjectPersistenceError
Defined in: src/errors.ts:62
An indeterminate storage failure: reconcile this ID before executing again.
Extends
Constructors
Constructor
new DataSubjectPersistenceError(
requestId,
tenantId,
dataOutcome): DataSubjectPersistenceError;Defined in: src/errors.ts:65
Parameters
| Parameter | Type |
|---|---|
requestId | string |
tenantId | string |
dataOutcome | "completed" | "not_started" | "unknown" |
Returns
Overrides
Properties
cause?
optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonly code: DataSubjectErrorCode;Defined in: src/errors.ts:50
Inherited from
dataOutcome
readonly dataOutcome: "completed" | "not_started" | "unknown";Defined in: src/errors.ts:68
httpStatus
readonly httpStatus: number;Defined in: src/errors.ts:51
Inherited from
message
message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
recovery
readonly recovery: "reconcile_request";Defined in: src/errors.ts:63
requestId
readonly requestId: string;Defined in: src/errors.ts:66
stack?
optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
stackTraceLimit
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
readonly tenantId: string;Defined in: src/errors.ts:67
Methods
captureStackTrace()
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.
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:
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
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
DataSubjectError.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:56
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
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
new DataSubjectService(deps): DataSubjectService;Defined in: src/data-subject.service.ts:68
Parameters
| Parameter | Type |
|---|---|
deps | DataSubjectServiceDeps |
Returns
Methods
erase()
erase(
subjectId,
tenantId,
context?): Promise<DataSubjectRequest>;Defined in: src/data-subject.service.ts:111
Parameters
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
context? | RequestContext |
Returns
Promise<DataSubjectRequest>
expirePendingArtifacts()
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
| Parameter | Type | Default value |
|---|---|---|
limit | number | 100 |
Returns
Promise<{ expired: number; failures: { code: string; requestId: string; tenantId: string; }[]; }>
export()
export(
subjectId,
tenantId,
context?): Promise<DataSubjectRequest>;Defined in: src/data-subject.service.ts:103
Parameters
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
context? | RequestContext |
Returns
Promise<DataSubjectRequest>
getArtifact()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise< | { body: Buffer; contentType: string; } | null>
getRequest()
getRequest(id, tenantId): Promise<DataSubjectRequest>;Defined in: src/data-subject.service.ts:172
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<DataSubjectRequest>
listByTenant()
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;Defined in: src/data-subject.service.ts:189
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
opts | { state?: RequestState; } |
opts.state? | RequestState |
Returns
Promise<DataSubjectRequest[]>
listOverdue()
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()
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
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
options | { ttlMs?: number; } |
options.ttlMs? | number |
Returns
Promise<ErasurePreview>
retryCompletion()
retryCompletion(id, tenantId): Promise<DataSubjectRequest>;Defined in: src/data-subject.service.ts:139
Retries only committed artifacts and durable notifications, never entity work.
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
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
new ErasureVerificationError(result): ErasureVerificationError;Defined in: src/erase-runner.ts:15
Parameters
| Parameter | Type |
|---|---|
result | EraseResult |
Returns
Overrides
Properties
cause?
optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonly code: DataSubjectErrorCode;Defined in: src/errors.ts:50
Inherited from
httpStatus
readonly httpStatus: number;Defined in: src/errors.ts:51
Inherited from
message
message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
result
readonly result: EraseResult;Defined in: src/erase-runner.ts:15
stack?
optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
stackTraceLimit
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
get actions(): ErasureEvidenceAction[];Defined in: src/erase-runner.ts:19
Returns
stats
Get Signature
get stats(): RequestStats;Defined in: src/erase-runner.ts:18
Returns
Methods
captureStackTrace()
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.
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:
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
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
DataSubjectError.captureStackTrace
prepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:56
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
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
new InMemoryArtifactStorage(): InMemoryArtifactStorage;Returns
Methods
get()
get(key): Promise<
| {
body: Buffer;
contentType: string;
}
| null>;Defined in: src/storage/in-memory-artifact-storage.ts:14
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise< | { body: Buffer; contentType: string; } | null>
Implementation of
put()
put(
key,
body,
contentType): Promise<string>;Defined in: src/storage/in-memory-artifact-storage.ts:9
Parameters
| Parameter | Type |
|---|---|
key | string |
body | Buffer |
contentType | string |
Returns
Promise<string>
Implementation of
InMemoryRequestStorage
Defined in: src/storage/in-memory-request-storage.ts:12
Implements
Constructors
Constructor
new InMemoryRequestStorage(): InMemoryRequestStorage;Returns
Methods
findById()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<DataSubjectRequest | null>
Implementation of
insert()
insert(req): Promise<void>;Defined in: src/storage/in-memory-request-storage.ts:15
Parameters
| Parameter | Type |
|---|---|
req | DataSubjectRequest |
Returns
Promise<void>
Implementation of
listByTenant()
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;Defined in: src/storage/in-memory-request-storage.ts:57
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
opts | { state?: RequestState; } |
opts.state? | RequestState |
Returns
Promise<DataSubjectRequest[]>
Implementation of
listOverdue()
listOverdue(now): Promise<DataSubjectRequest[]>;Defined in: src/storage/in-memory-request-storage.ts:68
Parameters
| Parameter | Type |
|---|---|
now | Date |
Returns
Promise<DataSubjectRequest[]>
Implementation of
update()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
patch | Partial<DataSubjectRequest> |
Returns
Promise<void>
Implementation of
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
new PostgresJobStore<TTransaction>(opts): PostgresJobStore<TTransaction>;Defined in: src/jobs/postgres-job-store.ts:53
Parameters
| Parameter | Type |
|---|---|
opts | PostgresJobStoreOptions<TTransaction> |
Returns
PostgresJobStore<TTransaction>
Methods
cancel()
cancel(id, tenantId): Promise<JobRecord>;Defined in: src/jobs/postgres-job-store.ts:105
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord>
Implementation of
deleteChunks()
deleteChunks(id, tenantId): Promise<void>;Defined in: src/jobs/postgres-job-store.ts:224
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<void>
Implementation of
get()
get(id, tenantId): Promise<JobRecord | null>;Defined in: src/jobs/postgres-job-store.ts:97
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord | null>
Implementation of
purgeExpiredChunks()
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
| Parameter | Type | Default value |
|---|---|---|
limit | number | 100 |
Returns
Promise<number>
Implementation of
DurableJobStore.purgeExpiredChunks
readChunks()
readChunks(id, tenantId): AsyncIterable<{
body: Buffer;
index: number;
}>;Defined in: src/jobs/postgres-job-store.ts:197
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
AsyncIterable<{ body: Buffer; index: number; }>
Implementation of
retry()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord>
Implementation of
runNext()
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
| Parameter | Type |
|---|---|
handler | JobHandler |
filter | JobFilter |
Returns
Promise<JobRecord | null>
Implementation of
submit()
submit(input): Promise<{
created: boolean;
job: JobRecord;
}>;Defined in: src/jobs/postgres-job-store.ts:71
Parameters
| Parameter | Type |
|---|---|
input | JobSubmitInput |
Returns
Promise<{ created: boolean; job: JobRecord; }>
Implementation of
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
new PrismaExecutionStore<TTransaction>(opts): PrismaExecutionStore<TTransaction>;Defined in: src/storage/prisma-execution-store.ts:73
Parameters
| Parameter | Type |
|---|---|
opts | PrismaExecutionStoreOptions<TTransaction> |
Returns
PrismaExecutionStore<TTransaction>
Properties
requests
readonly requests: PrismaRequestStorage;Defined in: src/storage/prisma-execution-store.ts:69
Implementation of
DurableExecutionStore.requests
Methods
listExpiredArtifacts()
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
| Parameter | Type |
|---|---|
now | Date |
limit | number |
Returns
Promise<{ requestId: string; tenantId: string; }[]>
Implementation of
DurableExecutionStore.listExpiredArtifacts
reserve()
reserve(
request,
idempotencyKey,
payloadHash): Promise<{
created: boolean;
request: DataSubjectRequest;
}>;Defined in: src/storage/prisma-execution-store.ts:116
Parameters
| Parameter | Type |
|---|---|
request | DataSubjectRequest |
idempotencyKey | string |
payloadHash | string |
Returns
Promise<{ created: boolean; request: DataSubjectRequest; }>
Implementation of
withLock()
withLock<T>(
requestId,
tenantId,
work): Promise<T>;Defined in: src/storage/prisma-execution-store.ts:161
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
requestId | string |
tenantId | string |
work | (transaction) => Promise<T> |
Returns
Promise<T>
Implementation of
DurableExecutionStore.withLock
PrismaRequestStorage
Defined in: src/storage/prisma-request-storage.ts:35
Implements
Constructors
Constructor
new PrismaRequestStorage(opts): PrismaRequestStorage;Defined in: src/storage/prisma-request-storage.ts:36
Parameters
| Parameter | Type |
|---|---|
opts | PrismaRequestStorageOptions |
Returns
Methods
findById()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<DataSubjectRequest | null>
Implementation of
insert()
insert(req): Promise<void>;Defined in: src/storage/prisma-request-storage.ts:38
Parameters
| Parameter | Type |
|---|---|
req | DataSubjectRequest |
Returns
Promise<void>
Implementation of
listByTenant()
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;Defined in: src/storage/prisma-request-storage.ts:84
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
opts | { state?: RequestState; } |
opts.state? | RequestState |
Returns
Promise<DataSubjectRequest[]>
Implementation of
listOverdue()
listOverdue(now): Promise<DataSubjectRequest[]>;Defined in: src/storage/prisma-request-storage.ts:99
Parameters
| Parameter | Type |
|---|---|
now | Date |
Returns
Promise<DataSubjectRequest[]>
Implementation of
update()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
patch | Partial<DataSubjectRequest> |
Returns
Promise<void>
Implementation of
Registry
Defined in: src/registry.ts:11
Constructors
Constructor
new Registry(opts?): Registry;Defined in: src/registry.ts:15
Parameters
| Parameter | Type |
|---|---|
opts | CompileOptions |
Returns
Methods
definitions()
definitions(): EntityDefinition[];Defined in: src/registry.ts:66
Returns
get()
get(name): RegisteredEntity | undefined;Defined in: src/registry.ts:39
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
RegisteredEntity | undefined
list()
list(): RegisteredEntity[];Defined in: src/registry.ts:70
Returns
register()
register(input): void;Defined in: src/registry.ts:17
Parameters
| Parameter | Type |
|---|---|
input | RegisterInput |
Returns
void
registerDefinition()
registerDefinition(definition, executor): void;Defined in: src/registry.ts:43
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
executor | EntityExecutor |
Returns
void
TranscendErasureAdapter
Defined in: src/integrations/transcend.ts:89
Experimental server-webhook adapter, independently scoped to one local erasure system.
Constructors
Constructor
new TranscendErasureAdapter(options): TranscendErasureAdapter;Defined in: src/integrations/transcend.ts:96
Parameters
| Parameter | Type |
|---|---|
options | TranscendAdapterOptions |
Returns
Methods
processStep()
processStep(__namedParameters): Promise<JobStepResult>;Defined in: src/integrations/transcend.ts:242
Use with jobs.runNext(adapter.processStep.bind(adapter), { kind: TRANSCEND_ERASURE_JOB }).
Parameters
| Parameter | Type |
|---|---|
__namedParameters | Pick<JobTransaction, "job"> |
Returns
Promise<JobStepResult>
receive()
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
| Parameter | Type |
|---|---|
input | { body: Buffer; headers: Record<string, string | string[] | undefined>; } |
input.body | Buffer |
input.headers | Record<string, string | string[] | undefined> |
Returns
Promise<{ created: boolean; job: JobRecord; }>
TranscendIntegrationError
Defined in: src/integrations/transcend-auth.ts:3
Extends
Error
Constructors
Constructor
new TranscendIntegrationError(code, retryable?): TranscendIntegrationError;Defined in: src/integrations/transcend-auth.ts:4
Parameters
| Parameter | Type | Default value |
|---|---|---|
code | | "invalid_configuration" | "invalid_webhook" | "unauthorized_webhook" | "unsupported_request" | "subject_not_mapped" | "invalid_job" | "provider_unavailable" | "local_execution_incomplete" | undefined |
retryable | boolean | false |
Returns
Overrides
Error.constructorProperties
cause?
optional cause?: unknown;Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.causecode
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
message: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.messagename
name: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.nameretryable
readonly retryable: boolean = false;Defined in: src/integrations/transcend-auth.ts:14
stack?
optional stack?: string;Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stackstackTraceLimit
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
Error.stackTraceLimitMethods
captureStackTrace()
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.
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:
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
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTraceprepareStackTrace()
static prepareStackTrace(err, stackTraces): any;Defined in: node_modules/@types/node/globals.d.ts:56
Parameters
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTraceInterfaces
ArtifactStorage
Defined in: src/storage/artifact-storage.interface.ts:1
Methods
get()
get(key): Promise<
| {
body: Buffer;
contentType: string;
}
| null>;Defined in: src/storage/artifact-storage.interface.ts:3
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise< | { body: Buffer; contentType: string; } | null>
put()
put(
key,
body,
contentType): Promise<string>;Defined in: src/storage/artifact-storage.interface.ts:2
Parameters
| Parameter | Type |
|---|---|
key | string |
body | Buffer |
contentType | string |
Returns
Promise<string>
CompileOptions
Defined in: src/policy-compiler.ts:5
Properties
strictLegalBasis?
optional strictLegalBasis?: boolean;Defined in: src/policy-compiler.ts:6
DataSubjectModuleOptions
Defined in: src/data-subject.module.ts:12
Properties
allowUnverified?
optional allowUnverified?: boolean;Defined in: src/data-subject.module.ts:24
artifactRetryTtlMs?
optional artifactRetryTtlMs?: {
erase?: number;
export?: number;
};Defined in: src/data-subject.module.ts:21
erase?
optional erase?: number;export?
optional export?: number;artifactStorage
artifactStorage: ArtifactStorage;Defined in: src/data-subject.module.ts:14
definitions?
optional definitions?: {
definition: EntityDefinition;
executor: EntityExecutor;
}[];Defined in: src/data-subject.module.ts:19
definition
definition: EntityDefinition;executor
executor: EntityExecutor;durableStore?
optional durableStore?: DurableExecutionStore;Defined in: src/data-subject.module.ts:20
entities?
optional entities?: RegisterInput[];Defined in: src/data-subject.module.ts:18
previewSigningKey?
optional previewSigningKey?: string | Buffer<ArrayBufferLike>;Defined in: src/data-subject.module.ts:22
previewTtlMs?
optional previewTtlMs?: number;Defined in: src/data-subject.module.ts:23
publishAudit?
optional publishAudit?: (event, data, delivery?) => Promise<void>;Defined in: src/data-subject.module.ts:26
Parameters
| Parameter | Type |
|---|---|
event | string |
data | Record<string, unknown> |
delivery? | DeliveryContext |
Returns
Promise<void>
publishOutbox?
optional publishOutbox?: (type, payload, delivery?) => Promise<void>;Defined in: src/data-subject.module.ts:25
Parameters
| Parameter | Type |
|---|---|
type | string |
payload | unknown |
delivery? | DeliveryContext |
Returns
Promise<void>
requestStorage
requestStorage: RequestStorage;Defined in: src/data-subject.module.ts:13
runInTransaction?
optional runInTransaction?: <T>(work) => Promise<T>;Defined in: src/data-subject.module.ts:27
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
work | () => Promise<T> |
Returns
Promise<T>
singleTenantId?
optional singleTenantId?: string;Defined in: src/data-subject.module.ts:16
slaDays?
optional slaDays?: number;Defined in: src/data-subject.module.ts:15
strictLegalBasis?
optional strictLegalBasis?: boolean;Defined in: src/data-subject.module.ts:17
DataSubjectRequest
Defined in: src/types.ts:57
Properties
artifactHash
artifactHash: string | null;Defined in: src/types.ts:68
artifactUrl
artifactUrl: string | null;Defined in: src/types.ts:69
completedAt
completedAt: Date | null;Defined in: src/types.ts:65
createdAt
createdAt: Date;Defined in: src/types.ts:63
dueAt
dueAt: Date;Defined in: src/types.ts:64
failedAt
failedAt: Date | null;Defined in: src/types.ts:66
failureReason
failureReason: string | null;Defined in: src/types.ts:67
id
id: string;Defined in: src/types.ts:58
requestedBy
requestedBy: string | null;Defined in: src/types.ts:71
state
state: RequestState;Defined in: src/types.ts:62
stats
stats: RequestStats | null;Defined in: src/types.ts:70
subjectId
subjectId: string;Defined in: src/types.ts:60
tenantId
tenantId: string;Defined in: src/types.ts:59
type
type: RequestType;Defined in: src/types.ts:61
DataSubjectServiceDeps
Defined in: src/data-subject.service.ts:33
Properties
allowUnverified?
optional allowUnverified?: boolean;Defined in: src/data-subject.service.ts:46
Legacy integrations only. Durable execution always requires verification.
artifactRetryTtlMs?
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?
optional erase?: number;export?
optional export?: number;artifactStorage
artifactStorage: ArtifactStorage;Defined in: src/data-subject.service.ts:36
clock?
optional clock?: () => Date;Defined in: src/data-subject.service.ts:48
Returns
Date
durableStore?
optional durableStore?: DurableExecutionStore;Defined in: src/data-subject.service.ts:40
idFactory?
optional idFactory?: () => string;Defined in: src/data-subject.service.ts:47
Returns
string
previewSigningKey?
optional previewSigningKey?: string | Buffer<ArrayBufferLike>;Defined in: src/data-subject.service.ts:43
previewTtlMs?
optional previewTtlMs?: number;Defined in: src/data-subject.service.ts:44
publishAudit?
optional publishAudit?: (event, data, delivery?) => Promise<void>;Defined in: src/data-subject.service.ts:50
Parameters
| Parameter | Type |
|---|---|
event | string |
data | Record<string, unknown> |
delivery? | DeliveryContext |
Returns
Promise<void>
publishOutbox?
optional publishOutbox?: (type, payload, delivery?) => Promise<void>;Defined in: src/data-subject.service.ts:49
Parameters
| Parameter | Type |
|---|---|
type | string |
payload | unknown |
delivery? | DeliveryContext |
Returns
Promise<void>
registry
registry: Registry;Defined in: src/data-subject.service.ts:34
requestStorage
requestStorage: RequestStorage;Defined in: src/data-subject.service.ts:35
runInTransaction?
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
| Parameter | Type |
|---|---|
work | () => Promise<T> |
Returns
Promise<T>
singleTenantId?
optional singleTenantId?: string;Defined in: src/data-subject.service.ts:39
Omit for multi-tenant mode. Every executor must declare a matching scope.
slaDays
slaDays: number;Defined in: src/data-subject.service.ts:37
DeliveryContext
Defined in: src/durable-coordinator.ts:18
Properties
id
id: string;Defined in: src/durable-coordinator.ts:19
requestId
requestId: string;Defined in: src/durable-coordinator.ts:20
tenantId
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
bodyBase64: string | null;Defined in: src/storage/durable-execution-store.interface.ts:8
contentType
contentType: string;Defined in: src/storage/durable-execution-store.interface.ts:7
discardedAt?
optional discardedAt?: string;Defined in: src/storage/durable-execution-store.interface.ts:12
expiresAt?
optional expiresAt?: string;Defined in: src/storage/durable-execution-store.interface.ts:11
hash
hash: string;Defined in: src/storage/durable-execution-store.interface.ts:9
key
key: string;Defined in: src/storage/durable-execution-store.interface.ts:6
url?
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
readonly requests: RequestStorage;Defined in: src/storage/durable-execution-store.interface.ts:46
Methods
listExpiredArtifacts()
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
| Parameter | Type |
|---|---|
now | Date |
limit | number |
Returns
Promise<{ requestId: string; tenantId: string; }[]>
reserve()
reserve(
request,
idempotencyKey,
payloadHash): Promise<{
created: boolean;
request: DataSubjectRequest;
}>;Defined in: src/storage/durable-execution-store.interface.ts:49
Parameters
| Parameter | Type |
|---|---|
request | DataSubjectRequest |
idempotencyKey | string |
payloadHash | string |
Returns
Promise<{ created: boolean; request: DataSubjectRequest; }>
withLock()
withLock<T>(
requestId,
tenantId,
work): Promise<T>;Defined in: src/storage/durable-execution-store.interface.ts:54
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
requestId | string |
tenantId | string |
work | (transaction) => Promise<T> |
Returns
Promise<T>
DurableJobStore
Defined in: src/jobs/types.ts:57
Methods
cancel()
cancel(id, tenantId): Promise<JobRecord>;Defined in: src/jobs/types.ts:60
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord>
deleteChunks()
deleteChunks(id, tenantId): Promise<void>;Defined in: src/jobs/types.ts:66
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<void>
get()
get(id, tenantId): Promise<JobRecord | null>;Defined in: src/jobs/types.ts:59
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord | null>
purgeExpiredChunks()
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
| Parameter | Type |
|---|---|
limit? | number |
Returns
Promise<number>
readChunks()
readChunks(id, tenantId): AsyncIterable<{
body: Buffer;
index: number;
}>;Defined in: src/jobs/types.ts:65
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
AsyncIterable<{ body: Buffer; index: number; }>
retry()
retry(id, tenantId): Promise<JobRecord>;Defined in: src/jobs/types.ts:62
Explicitly resume the committed checkpoint of a failed/cancelled job.
Parameters
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<JobRecord>
runNext()
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
| Parameter | Type |
|---|---|
handler | JobHandler |
filter? | JobFilter |
Returns
Promise<JobRecord | null>
submit()
submit(input): Promise<{
created: boolean;
job: JobRecord;
}>;Defined in: src/jobs/types.ts:58
Parameters
| Parameter | Type |
|---|---|
input | JobSubmitInput |
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?
optional dependsOn?: string[];Defined in: src/policy-compiler.ts:19
Parent entities: this entity is erased before each named parent.
Inherited from
entityName
entityName: string;Defined in: src/policy-compiler.ts:10
Inherited from
exportFields?
optional exportFields?: string[];Defined in: src/policy-compiler.ts:15
Explicit top-level export allowlist. Omit for an erase-only entity.
Inherited from
fields
fields: Record<string, PolicyEntry>;Defined in: src/policy-compiler.ts:13
Inherited from
ignoredFields?
optional ignoredFields?: Record<string, string>;Defined in: src/policy-definition.ts:9
Every deliberate scalar-field exclusion has an auditable explanation.
relations?
optional relations?: string[];Defined in: src/policy-definition.ts:11
Explicit Prisma relation field names reviewed by schema lint.
rowLevel?
optional rowLevel?: "delete-row" | "delete-fields";Defined in: src/policy-compiler.ts:12
Inherited from
scope
scope: TenantScope;Defined in: src/policy-definition.ts:7
stableIdField?
optional stableIdField?: string;Defined in: src/policy-compiler.ts:17
Immutable row identity used for post-write verification.
Inherited from
subjectField
subjectField: string;Defined in: src/policy-compiler.ts:11
Inherited from
EntityExecutor
Defined in: src/types.ts:35
Properties
identityField?
optional identityField?: string;Defined in: src/types.ts:38
scope?
optional scope?: TenantScope;Defined in: src/types.ts:37
Required at runtime by DataSubjectService; custom executors must enforce this scope.
Methods
anonymize()
anonymize(
subjectId,
tenantId,
replacements): Promise<number>;Defined in: src/types.ts:42
Parameters
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
replacements | Record<string, unknown> |
Returns
Promise<number>
erase()
erase(
subjectId,
tenantId,
plan): Promise<number>;Defined in: src/types.ts:41
Parameters
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
plan | ErasePlan |
Returns
Promise<number>
select()
select(subjectId, tenantId): Promise<Record<string, unknown>[]>;Defined in: src/types.ts:40
Parameters
| Parameter | Type |
|---|---|
subjectId | string |
tenantId | string |
Returns
Promise<Record<string, unknown>[]>
selectByIds()?
optional selectByIds(ids, tenantId): Promise<Record<string, unknown>[]>;Defined in: src/types.ts:39
Parameters
| Parameter | Type |
|---|---|
ids | unknown[] |
tenantId | string |
Returns
Promise<Record<string, unknown>[]>
EntityPolicy
Defined in: src/types.ts:16
Properties
dependsOn?
optional dependsOn?: string[];Defined in: src/types.ts:23
entityName
entityName: string;Defined in: src/types.ts:17
exportFields
exportFields: string[];Defined in: src/types.ts:21
fields
fields: Record<string, PolicyEntry>;Defined in: src/types.ts:20
rowLevel
rowLevel: RowLevel;Defined in: src/types.ts:19
stableIdField?
optional stableIdField?: string;Defined in: src/types.ts:22
subjectField
subjectField: string;Defined in: src/types.ts:18
EntityVerification
Defined in: src/types.ts:161
Properties
checkedRows
checkedRows: number;Defined in: src/types.ts:163
fields
fields: {
checked: number;
field: string;
status: "failed" | "verified" | "unverified";
strategy: Strategy;
}[];Defined in: src/types.ts:164
checked
checked: number;field
field: string;status
status: "failed" | "verified" | "unverified";strategy
strategy: Strategy;status
status: "failed" | "verified" | "unverified";Defined in: src/types.ts:162
ErasePlan
Defined in: src/types.ts:26
Properties
deleteFields
deleteFields: string[];Defined in: src/types.ts:28
rowLevel
rowLevel: RowLevel;Defined in: src/types.ts:27
ErasureEvidenceAction
Defined in: src/types.ts:127
Properties
affected
affected: number;Defined in: src/types.ts:130
anonymizedFields?
optional anonymizedFields?: string[];Defined in: src/types.ts:135
deleteFields?
optional deleteFields?: string[];Defined in: src/types.ts:134
effectiveRowStrategy?
optional effectiveRowStrategy?: "retain" | "delete-row" | "update-fields";Defined in: src/types.ts:132
entityName
entityName: string;Defined in: src/types.ts:128
retainedFields?
optional retainedFields?: {
count: number;
field: string;
legalBasis: string;
until?: string;
}[];Defined in: src/types.ts:136
count
count: number;field
field: string;legalBasis
legalBasis: string;until?
optional until?: string;rowLevel
rowLevel: RowLevel;Defined in: src/types.ts:131
strategy
strategy: Strategy | "mixed";Defined in: src/types.ts:129
verification?
optional verification?: EntityVerification;Defined in: src/types.ts:133
ErasureEvidenceArtifact
Defined in: src/types.ts:144
Properties
actions
actions: ErasureEvidenceAction[];Defined in: src/types.ts:155
artifactHashAlgorithm
artifactHashAlgorithm: "sha256";Defined in: src/types.ts:158
failureStage?
optional failureStage?: FailureStage;Defined in: src/types.ts:148
generatedAt
generatedAt: string;Defined in: src/types.ts:152
policyHash?
optional policyHash?: string;Defined in: src/types.ts:146
postScan
postScan: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:156
count
count: number;entityName
entityName: string;preScan
preScan: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:154
count
count: number;entityName
entityName: string;requestId
requestId: string;Defined in: src/types.ts:149
requestType
requestType: "erase";Defined in: src/types.ts:151
schemaVersion
schemaVersion:
| "data-subject.erasure-evidence.v1"
| "data-subject.erasure-evidence.v2";Defined in: src/types.ts:145
state
state: "completed" | "failed";Defined in: src/types.ts:153
tenantId
tenantId: string;Defined in: src/types.ts:150
verificationOverall?
optional verificationOverall?: "failed" | "verified" | "unverified";Defined in: src/types.ts:147
verificationResidual
verificationResidual: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:157
count
count: number;entityName
entityName: string;ErasurePlanEntity
Defined in: src/erasure-plan.ts:9
Properties
anonymizedFields
anonymizedFields: string[];Defined in: src/erasure-plan.ts:14
deleteFields
deleteFields: string[];Defined in: src/erasure-plan.ts:13
effectiveRowStrategy
effectiveRowStrategy: EffectiveRowStrategy;Defined in: src/erasure-plan.ts:12
entityName
entityName: string;Defined in: src/erasure-plan.ts:10
expectedRows
expectedRows: number;Defined in: src/erasure-plan.ts:11
retainedFields
retainedFields: {
field: string;
legalBasis: string;
until?: string;
}[];Defined in: src/erasure-plan.ts:15
field
field: string;legalBasis
legalBasis: string;until?
optional until?: string;verification
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
entities: ErasurePlanEntity[];Defined in: src/erasure-plan.ts:24
policyHash
policyHash: string;Defined in: src/erasure-plan.ts:22
schemaVersion
schemaVersion: "data-subject.erasure-plan.v1";Defined in: src/erasure-plan.ts:21
scopeHash
scopeHash: string;Defined in: src/erasure-plan.ts:23
ErasurePreview
Defined in: src/preview.ts:7
Properties
expiresAt
expiresAt: string;Defined in: src/preview.ts:12
issuedAt
issuedAt: string;Defined in: src/preview.ts:11
plan
plan: ErasurePlanSummary;Defined in: src/preview.ts:13
schemaVersion
schemaVersion: "data-subject.preview.v1";Defined in: src/preview.ts:8
signature
signature: string;Defined in: src/preview.ts:14
subjectId
subjectId: string;Defined in: src/preview.ts:9
tenantId
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
channel: "outbox" | "audit";Defined in: src/storage/durable-execution-store.interface.ts:18
delivered
delivered: boolean;Defined in: src/storage/durable-execution-store.interface.ts:21
event
event: string;Defined in: src/storage/durable-execution-store.interface.ts:19
id
id: string;Defined in: src/storage/durable-execution-store.interface.ts:17
lastError?
optional lastError?: string;Defined in: src/storage/durable-execution-store.interface.ts:22
payload
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
artifact: DurableArtifact | null;Defined in: src/storage/durable-execution-store.interface.ts:32
idempotencyKey
readonly idempotencyKey: string;Defined in: src/storage/durable-execution-store.interface.ts:29
notifications
notifications: ExecutionNotification[];Defined in: src/storage/durable-execution-store.interface.ts:34
payloadHash
readonly payloadHash: string;Defined in: src/storage/durable-execution-store.interface.ts:30
phase
phase: "completed" | "pending" | "data_committed";Defined in: src/storage/durable-execution-store.interface.ts:31
requestId
readonly requestId: string;Defined in: src/storage/durable-execution-store.interface.ts:26
stats
stats: RequestStats | null;Defined in: src/storage/durable-execution-store.interface.ts:33
tenantId
readonly tenantId: string;Defined in: src/storage/durable-execution-store.interface.ts:27
type
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
record: ExecutionRecord;Defined in: src/storage/durable-execution-store.interface.ts:38
requests
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()
save(record): Promise<void>;Defined in: src/storage/durable-execution-store.interface.ts:41
Parameters
| Parameter | Type |
|---|---|
record | ExecutionRecord |
Returns
Promise<void>
FromPrismaOptions
Defined in: src/prisma/from-prisma.ts:17
Properties
delegate
delegate: PrismaDelegate;Defined in: src/prisma/from-prisma.ts:18
singleTenantId?
optional singleTenantId?: string;Defined in: src/prisma/from-prisma.ts:22
Explicit scope for databases which contain exactly one tenant.
stableIdField?
optional stableIdField?: string;Defined in: src/prisma/from-prisma.ts:24
Immutable unique scalar key used to verify rows after subject-field updates.
subjectField
subjectField: string;Defined in: src/prisma/from-prisma.ts:19
tenantField?
optional tenantField?: string;Defined in: src/prisma/from-prisma.ts:20
JobFilter
Defined in: src/jobs/types.ts:55
Properties
kind?
optional kind?: string;Defined in: src/jobs/types.ts:55
tenantId?
optional tenantId?: string;Defined in: src/jobs/types.ts:55
JobRecord
Defined in: src/jobs/types.ts:12
Extends
Properties
attempts
attempts: number;Defined in: src/jobs/types.ts:21
Consecutive failed steps. A successfully committed page resets this count.
availableAt
availableAt: Date;Defined in: src/jobs/types.ts:29
checkpoint
checkpoint: JobJson;Defined in: src/jobs/types.ts:15
chunksDeletedAt
chunksDeletedAt: Date | null;Defined in: src/jobs/types.ts:31
chunksWritten
chunksWritten: number;Defined in: src/jobs/types.ts:19
completedAt
completedAt: Date | null;Defined in: src/jobs/types.ts:30
createdAt
createdAt: Date;Defined in: src/jobs/types.ts:27
expiresAt
expiresAt: Date;Defined in: src/jobs/types.ts:33
Immutable payload/chunk retention deadline, measured by the database clock.
hasCommittedChanges
hasCommittedChanges: boolean;Defined in: src/jobs/types.ts:23
id
id: string;Defined in: src/jobs/types.ts:5
Inherited from
idempotencyKey
idempotencyKey: string;Defined in: src/jobs/types.ts:8
Inherited from
kind
kind: string;Defined in: src/jobs/types.ts:7
Inherited from
lastError
lastError: string | null;Defined in: src/jobs/types.ts:26
pagesCommitted
pagesCommitted: number;Defined in: src/jobs/types.ts:18
partial
partial: boolean;Defined in: src/jobs/types.ts:25
Failed/cancelled with committed changes, or possible external changes requiring reconciliation.
payload
payload: JobJson;Defined in: src/jobs/types.ts:9
Inherited from
payloadHash
readonly payloadHash: string;Defined in: src/jobs/types.ts:13
processedRows
processedRows: number;Defined in: src/jobs/types.ts:17
purgedAt
purgedAt: Date | null;Defined in: src/jobs/types.ts:34
result
result: JobJson;Defined in: src/jobs/types.ts:16
revision
revision: number;Defined in: src/jobs/types.ts:22
state
state: "completed" | "failed" | "queued" | "cancelled";Defined in: src/jobs/types.ts:14
tenantId
tenantId: string;Defined in: src/jobs/types.ts:6
Inherited from
updatedAt
updatedAt: Date;Defined in: src/jobs/types.ts:28
JobStepResult
Defined in: src/jobs/types.ts:37
Properties
checkpoint
checkpoint: JobJson;Defined in: src/jobs/types.ts:39
done
done: boolean;Defined in: src/jobs/types.ts:38
hasCommittedChanges?
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
processedRows: number;Defined in: src/jobs/types.ts:41
Number of scope rows processed by this page, not a cumulative total.
result?
optional result?: JobJson;Defined in: src/jobs/types.ts:44
JobSubmitInput
Defined in: src/jobs/types.ts:4
Extended by
Properties
id
id: string;Defined in: src/jobs/types.ts:5
idempotencyKey
idempotencyKey: string;Defined in: src/jobs/types.ts:8
kind
kind: string;Defined in: src/jobs/types.ts:7
payload
payload: JobJson;Defined in: src/jobs/types.ts:9
tenantId
tenantId: string;Defined in: src/jobs/types.ts:6
JobTransaction
Defined in: src/jobs/types.ts:47
Properties
job
readonly job: JobRecord;Defined in: src/jobs/types.ts:49
Snapshot of the locked job. Mutating this object does not persist anything.
Methods
appendChunk()
appendChunk(body): Promise<void>;Defined in: src/jobs/types.ts:51
At most one bounded immutable chunk per page, committed with the checkpoint.
Parameters
| Parameter | Type |
|---|---|
body | Buffer |
Returns
Promise<void>
LegalBasisOptions
Defined in: src/legal-basis.ts:1
Properties
strict?
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
identityField: string;Defined in: src/jobs/paged-privacy.ts:23
scope
scope: TenantScope;Defined in: src/jobs/paged-privacy.ts:24
Methods
eraseByIds()
eraseByIds(ids, tenantId): Promise<number>;Defined in: src/jobs/paged-privacy.ts:28
Parameters
| Parameter | Type |
|---|---|
ids | PagedId[] |
tenantId | string |
Returns
Promise<number>
highWatermark()
highWatermark(input): Promise<PagedId | null>;Defined in: src/jobs/paged-privacy.ts:25
Parameters
| Parameter | Type |
|---|---|
input | { subjectId: string; tenantId: string; } |
input.subjectId | string |
input.tenantId | string |
Returns
Promise<PagedId | null>
readPage()
readPage(input): Promise<Record<string, unknown>[]>;Defined in: src/jobs/paged-privacy.ts:26
Parameters
| Parameter | Type |
|---|---|
input | PagedReadInput |
Returns
Promise<Record<string, unknown>[]>
selectByIds()
selectByIds(
ids,
tenantId,
fields?): Promise<Record<string, unknown>[]>;Defined in: src/jobs/paged-privacy.ts:27
Parameters
| Parameter | Type |
|---|---|
ids | PagedId[] |
tenantId | string |
fields? | string[] |
Returns
Promise<Record<string, unknown>[]>
updateByIds()
updateByIds(
ids,
tenantId,
replacements): Promise<number>;Defined in: src/jobs/paged-privacy.ts:29
Parameters
| Parameter | Type |
|---|---|
ids | PagedId[] |
tenantId | string |
replacements | Record<string, unknown> |
Returns
Promise<number>
PagedFromPrismaOptions
Defined in: src/prisma/paged-from-prisma.ts:15
Properties
delegate
delegate: PagedPrismaDelegate;Defined in: src/prisma/paged-from-prisma.ts:16
singleTenantId?
optional singleTenantId?: string;Defined in: src/prisma/paged-from-prisma.ts:19
stableIdField?
optional stableIdField?: string;Defined in: src/prisma/paged-from-prisma.ts:21
A unique immutable string or safe-integer Prisma scalar key.
subjectField
subjectField: string;Defined in: src/prisma/paged-from-prisma.ts:17
tenantField?
optional tenantField?: string;Defined in: src/prisma/paged-from-prisma.ts:18
PagedPrismaDelegate
Defined in: src/prisma/paged-from-prisma.ts:4
Methods
deleteMany()
deleteMany(args): Promise<{
count: number;
}>;Defined in: src/prisma/paged-from-prisma.ts:11
Parameters
| Parameter | Type |
|---|---|
args | { where: Record<string, unknown>; } |
args.where | Record<string, unknown> |
Returns
Promise<{ count: number; }>
findMany()
findMany(args): Promise<Record<string, unknown>[]>;Defined in: src/prisma/paged-from-prisma.ts:5
Parameters
| Parameter | Type |
|---|---|
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.take | number |
args.where | Record<string, unknown> |
Returns
Promise<Record<string, unknown>[]>
updateMany()
updateMany(args): Promise<{
count: number;
}>;Defined in: src/prisma/paged-from-prisma.ts:12
Parameters
| Parameter | Type |
|---|---|
args | { data: Record<string, unknown>; where: Record<string, unknown>; } |
args.data | Record<string, unknown> |
args.where | Record<string, unknown> |
Returns
Promise<{ count: number; }>
PagedPrivacyOptions
Defined in: src/jobs/paged-privacy.ts:40
Properties
batchSize?
optional batchSize?: number;Defined in: src/jobs/paged-privacy.ts:46
excludedModels?
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
executors: Record<string, PagedEntityExecutor>;Defined in: src/jobs/paged-privacy.ts:45
maxChunkBytes?
optional maxChunkBytes?: number;Defined in: src/jobs/paged-privacy.ts:47
registry
registry: Registry;Defined in: src/jobs/paged-privacy.ts:41
schemaSource
schemaSource: string;Defined in: src/jobs/paged-privacy.ts:42
PagedPrivacyPayload
Defined in: src/jobs/paged-privacy.ts:33
Properties
policyHash
policyHash: string;Defined in: src/jobs/paged-privacy.ts:37
schemaVersion
schemaVersion: "data-subject.paged-privacy.v1";Defined in: src/jobs/paged-privacy.ts:34
subjectId
subjectId: string;Defined in: src/jobs/paged-privacy.ts:36
type
type: "export" | "erase";Defined in: src/jobs/paged-privacy.ts:35
PagedReadInput
Defined in: src/jobs/paged-privacy.ts:13
Properties
after?
optional after?: PagedId;Defined in: src/jobs/paged-privacy.ts:16
fields?
optional fields?: string[];Defined in: src/jobs/paged-privacy.ts:19
limit
limit: number;Defined in: src/jobs/paged-privacy.ts:18
subjectId
subjectId: string;Defined in: src/jobs/paged-privacy.ts:14
tenantId
tenantId: string;Defined in: src/jobs/paged-privacy.ts:15
through
through: PagedId;Defined in: src/jobs/paged-privacy.ts:17
PolicySpec
Defined in: src/policy-compiler.ts:9
Extended by
Properties
dependsOn?
optional dependsOn?: string[];Defined in: src/policy-compiler.ts:19
Parent entities: this entity is erased before each named parent.
entityName
entityName: string;Defined in: src/policy-compiler.ts:10
exportFields?
optional exportFields?: string[];Defined in: src/policy-compiler.ts:15
Explicit top-level export allowlist. Omit for an erase-only entity.
fields
fields: Record<string, PolicyEntry>;Defined in: src/policy-compiler.ts:13
rowLevel?
optional rowLevel?: "delete-row" | "delete-fields";Defined in: src/policy-compiler.ts:12
stableIdField?
optional stableIdField?: string;Defined in: src/policy-compiler.ts:17
Immutable row identity used for post-write verification.
subjectField
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()
$queryRawUnsafe(query, ...values): Promise<unknown>;Defined in: src/jobs/postgres-job-store.ts:9
Parameters
| Parameter | Type |
|---|---|
query | string |
...values | unknown[] |
Returns
Promise<unknown>
Inherited from
PostgresJobTransactionClient.$queryRawUnsafe
$transaction()
$transaction<T>(work, options?): Promise<T>;Defined in: src/jobs/postgres-job-store.ts:14
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
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?
optional chunkTableName?: string;Defined in: src/jobs/postgres-job-store.ts:25
client
client: PostgresJobClient<TTransaction>;Defined in: src/jobs/postgres-job-store.ts:21
maxAttempts?
optional maxAttempts?: number;Defined in: src/jobs/postgres-job-store.ts:29
maxChunkBytes?
optional maxChunkBytes?: number;Defined in: src/jobs/postgres-job-store.ts:31
maxJsonBytes?
optional maxJsonBytes?: number;Defined in: src/jobs/postgres-job-store.ts:32
retentionMs?
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?
optional retryDelayMs?: number;Defined in: src/jobs/postgres-job-store.ts:30
schemaName?
optional schemaName?: string;Defined in: src/jobs/postgres-job-store.ts:26
serializationAttempts?
optional serializationAttempts?: number;Defined in: src/jobs/postgres-job-store.ts:28
tableName?
optional tableName?: string;Defined in: src/jobs/postgres-job-store.ts:24
transactionOptions?
optional transactionOptions?: {
maxWait?: number;
timeout?: number;
};Defined in: src/jobs/postgres-job-store.ts:27
maxWait?
optional maxWait?: number;timeout?
optional timeout?: number;Methods
bindTransaction()
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
| Parameter | Type |
|---|---|
transaction | TTransaction |
work | () => Promise<T> |
Returns
Promise<T>
PostgresJobTransactionClient
Defined in: src/jobs/postgres-job-store.ts:8
Extended by
Methods
$queryRawUnsafe()
$queryRawUnsafe(query, ...values): Promise<unknown>;Defined in: src/jobs/postgres-job-store.ts:9
Parameters
| Parameter | Type |
|---|---|
query | string |
...values | unknown[] |
Returns
Promise<unknown>
PrismaDataSubjectRequestDelegate
Defined in: src/storage/prisma-request-storage.ts:12
Methods
create()
create(args): Promise<unknown>;Defined in: src/storage/prisma-request-storage.ts:13
Parameters
| Parameter | Type |
|---|---|
args | { data: Record<string, unknown>; } |
args.data | Record<string, unknown> |
Returns
Promise<unknown>
findMany()
findMany(args): Promise<unknown[]>;Defined in: src/storage/prisma-request-storage.ts:21
Parameters
| Parameter | Type |
|---|---|
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.lt | Date |
args.where.state? | | RequestState | { in: RequestState[]; } |
args.where.tenantId? | string |
Returns
Promise<unknown[]>
findUnique()
findUnique(args): Promise<unknown>;Defined in: src/storage/prisma-request-storage.ts:18
Parameters
| Parameter | Type |
|---|---|
args | { where: { id: string; tenantId: string; }; } |
args.where | { id: string; tenantId: string; } |
args.where.id | string |
args.where.tenantId | string |
Returns
Promise<unknown>
update()
update(args): Promise<unknown>;Defined in: src/storage/prisma-request-storage.ts:14
Parameters
| Parameter | Type |
|---|---|
args | { data: Record<string, unknown>; where: { id: string; tenantId: string; }; } |
args.data | Record<string, unknown> |
args.where | { id: string; tenantId: string; } |
args.where.id | string |
args.where.tenantId | string |
Returns
Promise<unknown>
PrismaDelegate
Defined in: src/prisma/from-prisma.ts:4
Methods
deleteMany()
deleteMany(args): Promise<{
count: number;
}>;Defined in: src/prisma/from-prisma.ts:8
Parameters
| Parameter | Type |
|---|---|
args | { where: Record<string, unknown>; } |
args.where | Record<string, unknown> |
Returns
Promise<{ count: number; }>
findMany()
findMany(args): Promise<Record<string, unknown>[]>;Defined in: src/prisma/from-prisma.ts:5
Parameters
| Parameter | Type |
|---|---|
args | { where: Record<string, unknown>; } |
args.where | Record<string, unknown> |
Returns
Promise<Record<string, unknown>[]>
updateMany()
updateMany(args): Promise<{
count: number;
}>;Defined in: src/prisma/from-prisma.ts:11
Parameters
| Parameter | Type |
|---|---|
args | { data: Record<string, unknown>; where: Record<string, unknown>; } |
args.data | Record<string, unknown> |
args.where | Record<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
dataSubjectExecution: PrismaExecutionDelegate;Defined in: src/storage/prisma-execution-store.ts:45
dataSubjectRequest
dataSubjectRequest: PrismaDataSubjectRequestDelegate;Defined in: src/storage/prisma-execution-store.ts:44
Methods
$transaction()
$transaction<T>(work, options?): Promise<T>;Defined in: src/storage/prisma-execution-store.ts:46
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
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
client: PrismaExecutionClient<TTransaction>;Defined in: src/storage/prisma-execution-store.ts:53
executionSchemaName?
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?
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?
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?
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?
optional maxWait?: number;timeout?
optional timeout?: number;Methods
bindTransaction()
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
| Parameter | Type |
|---|---|
transaction | TTransaction |
work | () => Promise<T> |
Returns
Promise<T>
PrismaExecutionTransactionClient
Defined in: src/storage/prisma-execution-store.ts:37
Properties
dataSubjectExecution
dataSubjectExecution: PrismaExecutionDelegate;Defined in: src/storage/prisma-execution-store.ts:39
dataSubjectRequest
dataSubjectRequest: PrismaDataSubjectRequestDelegate;Defined in: src/storage/prisma-execution-store.ts:38
Methods
$queryRawUnsafe()
$queryRawUnsafe(query, ...values): Promise<unknown>;Defined in: src/storage/prisma-execution-store.ts:40
Parameters
| Parameter | Type |
|---|---|
query | string |
...values | unknown[] |
Returns
Promise<unknown>
PrismaRequestStorageOptions
Defined in: src/storage/prisma-request-storage.ts:31
Properties
delegate
delegate: PrismaDataSubjectRequestDelegate;Defined in: src/storage/prisma-request-storage.ts:32
RegisteredEntity
Defined in: src/types.ts:49
Properties
executor
executor: EntityExecutor;Defined in: src/types.ts:51
policy
policy: EntityPolicy;Defined in: src/types.ts:50
RegisterInput
Defined in: src/registry.ts:6
Properties
executor
executor: EntityExecutor;Defined in: src/registry.ts:8
policy
policy: PolicySpec;Defined in: src/registry.ts:7
RegistryValidationOptions
Defined in: src/registry-validation.ts:6
Properties
requireTenantField?
optional requireTenantField?: boolean;Defined in: src/registry-validation.ts:7
schemaSource?
optional schemaSource?: string;Defined in: src/registry-validation.ts:9
Schema validation requires every entity to use registerDefinition.
strictCoverage?
optional strictCoverage?: boolean;Defined in: src/registry-validation.ts:10
suppressions?
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
findings: DataSubjectLintFinding[];Defined in: src/registry-validation.ts:17
ok
ok: boolean;Defined in: src/registry-validation.ts:16
RequestContext
Defined in: src/data-subject.service.ts:26
Properties
preview?
optional preview?: ErasurePreview;Defined in: src/data-subject.service.ts:30
requestedBy?
optional requestedBy?: string;Defined in: src/data-subject.service.ts:28
The host must authenticate this actor and authorize the verified subject first.
requestKey?
optional requestKey?: string;Defined in: src/data-subject.service.ts:29
RequestLifecycle
Defined in: src/types.ts:108
Properties
artifactFailure?
optional artifactFailure?: {
code: string;
recovery: "retry_artifact" | "artifact_expired";
};Defined in: src/types.ts:109
code
code: string;recovery
recovery: "retry_artifact" | "artifact_expired";dataOutcome
dataOutcome: "completed" | "not_started" | "unknown";Defined in: src/types.ts:110
failureStage?
optional failureStage?: FailureStage;Defined in: src/types.ts:111
notificationFailures?
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
channel: "outbox" | "audit";code
code: string;event
event: string;recovery
recovery: "retry_notification";recovery?
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
entities: {
affected: number;
entityName: string;
strategy: RequestEntityStrategy;
}[];Defined in: src/types.ts:79
affected
affected: number;entityName
entityName: string;strategy
strategy: RequestEntityStrategy;evidence?
optional evidence?: {
artifactHash: string;
artifactUrl: string;
schemaVersion: "data-subject.evidence.v1" | "data-subject.evidence.v2";
};Defined in: src/types.ts:94
artifactHash
artifactHash: string;artifactUrl
artifactUrl: string;schemaVersion
schemaVersion: "data-subject.evidence.v1" | "data-subject.evidence.v2";lifecycle?
optional lifecycle?: RequestLifecycle;Defined in: src/types.ts:78
Stored in the existing stats JSON column; no schema migration is required.
policyHash?
optional policyHash?: string;Defined in: src/types.ts:75
postScan?
optional postScan?: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:93
count
count: number;entityName
entityName: string;preScan?
optional preScan?: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:92
count
count: number;entityName
entityName: string;retained?
optional retained?: {
count: number;
entityName: string;
field: string;
legalBasis: string;
until?: string;
}[];Defined in: src/types.ts:84
count
count: number;entityName
entityName: string;field
field: string;legalBasis
legalBasis: string;until?
optional until?: string;verification?
optional verification?: {
entityName: string;
} & EntityVerification[];Defined in: src/types.ts:76
verificationResidual?
optional verificationResidual?: {
count: number;
entityName: string;
}[];Defined in: src/types.ts:91
count
count: number;entityName
entityName: string;RequestStorage
Defined in: src/storage/request-storage.interface.ts:3
Methods
findById()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
Returns
Promise<DataSubjectRequest | null>
insert()
insert(req): Promise<void>;Defined in: src/storage/request-storage.interface.ts:4
Parameters
| Parameter | Type |
|---|---|
req | DataSubjectRequest |
Returns
Promise<void>
listByTenant()
listByTenant(tenantId, opts?): Promise<DataSubjectRequest[]>;Defined in: src/storage/request-storage.interface.ts:13
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
opts? | { state?: RequestState; } |
opts.state? | RequestState |
Returns
Promise<DataSubjectRequest[]>
listOverdue()
listOverdue(now): Promise<DataSubjectRequest[]>;Defined in: src/storage/request-storage.interface.ts:17
Parameters
| Parameter | Type |
|---|---|
now | Date |
Returns
Promise<DataSubjectRequest[]>
update()
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
| Parameter | Type |
|---|---|
id | string |
tenantId | string |
patch | Partial<DataSubjectRequest> |
Returns
Promise<void>
TranscendAdapterOptions
Defined in: src/integrations/transcend.ts:65
Properties
bindings
bindings: readonly TranscendBinding[];Defined in: src/integrations/transcend.ts:66
callbackTimeoutMs?
optional callbackTimeoutMs?: number;Defined in: src/integrations/transcend.ts:72
clock?
optional clock?: () => Date;Defined in: src/integrations/transcend.ts:71
Returns
Date
http?
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
| Parameter | Type |
|---|---|
request | TranscendHttpRequest |
Returns
Promise<{ status: number; }>
jobs
jobs: Pick<DurableJobStore, "submit" | "get">;Defined in: src/integrations/transcend.ts:67
nonceEncryptionKey
nonceEncryptionKey: Buffer;Defined in: src/integrations/transcend.ts:70
Keep this stable across workers/restarts. Rotate only after draining old jobs.
service
service: Pick<DataSubjectService, "erase" | "getRequest" | "retryCompletion">;Defined in: src/integrations/transcend.ts:68
TranscendBinding
Defined in: src/integrations/transcend.ts:35
Properties
allowTestRequests?
optional allowTestRequests?: boolean;Defined in: src/integrations/transcend.ts:52
Test webhooks are rejected unless explicitly routed to this test binding.
apiKey
apiKey: string;Defined in: src/integrations/transcend.ts:47
audience
audience: string;Defined in: src/integrations/transcend.ts:41
dataSiloId
dataSiloId: string;Defined in: src/integrations/transcend.ts:39
dataSubjectType
dataSubjectType: string;Defined in: src/integrations/transcend.ts:50
id
id: string;Defined in: src/integrations/transcend.ts:37
Stable operator-selected identity; never choose a tenant from the webhook body.
identifierType
identifierType: string;Defined in: src/integrations/transcend.ts:49
organizationId
organizationId: string;Defined in: src/integrations/transcend.ts:38
publicKeys
publicKeys: readonly string[];Defined in: src/integrations/transcend.ts:42
sombraApiKey?
optional sombraApiKey?: string;Defined in: src/integrations/transcend.ts:48
sombraOrigin
sombraOrigin: string;Defined in: src/integrations/transcend.ts:46
Operator-configured HTTPS origin, without path/query/userinfo.
tenantId
tenantId: string;Defined in: src/integrations/transcend.ts:40
webhookSecret
webhookSecret: string;Defined in: src/integrations/transcend.ts:44
Set this as a custom x-data-subject-webhook-secret header in Transcend.
Methods
resolveSubject()
resolveSubject(identifier): Promise<string | null>;Defined in: src/integrations/transcend.ts:53
Parameters
| Parameter | Type |
|---|---|
identifier | string |
Returns
Promise<string | null>
TranscendHttpRequest
Defined in: src/integrations/transcend.ts:56
Properties
body
body: string;Defined in: src/integrations/transcend.ts:60
headers
headers: Record<string, string>;Defined in: src/integrations/transcend.ts:59
method
method: "PUT";Defined in: src/integrations/transcend.ts:58
redirect
redirect: "error";Defined in: src/integrations/transcend.ts:61
signal
signal: AbortSignal;Defined in: src/integrations/transcend.ts:62
url
url: string;Defined in: src/integrations/transcend.ts:57
Type Aliases
DataSubjectErrorCode
type DataSubjectErrorCode = typeof DataSubjectErrorCode[keyof typeof DataSubjectErrorCode];Defined in: src/errors.ts:3
DataSubjectOutboxEvent
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
type FailureStage =
| "request_created"
| "processing"
| "data_execution"
| "artifact_write"
| "completion_persistence";Defined in: src/types.ts:101
JobHandler
type JobHandler = (transaction) => Promise<JobStepResult>;Defined in: src/jobs/types.ts:54
Parameters
| Parameter | Type |
|---|---|
transaction | JobTransaction |
Returns
Promise<JobStepResult>
JobJson
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
type PagedId = string | number;Defined in: src/jobs/paged-privacy.ts:12
PolicyEntry
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
type RequestEntityStrategy = Strategy | "mixed" | "export";Defined in: src/types.ts:2
RequestState
type RequestState = "created" | "validating" | "processing" | "completed" | "failed";Defined in: src/types.ts:55
RequestType
type RequestType = "export" | "erase";Defined in: src/types.ts:54
RowLevel
type RowLevel = "delete-row" | "delete-fields";Defined in: src/types.ts:3
Strategy
type Strategy = "delete" | "anonymize" | "retain";Defined in: src/types.ts:1
TenantScope
type TenantScope =
| {
mode: "multi-tenant";
tenantField: string;
}
| {
mode: "single-tenant";
tenantId: string;
};Defined in: src/types.ts:31
Variables
DATA_SUBJECT_REGISTRY
const DATA_SUBJECT_REGISTRY: typeof DATA_SUBJECT_REGISTRY;Defined in: src/data-subject.module.ts:10
DataSubjectErrorCode
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
| Name | Type | Default value | Defined 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
const PAGED_PRIVACY_JOB_KIND: "data-subject.privacy" = 'data-subject.privacy';Defined in: src/jobs/paged-privacy.ts:32
TRANSCEND_ERASURE_JOB
const TRANSCEND_ERASURE_JOB: "transcend-erasure" = 'transcend-erasure';Defined in: src/integrations/transcend.ts:33
Functions
buildErasureEvidenceArtifact()
function buildErasureEvidenceArtifact(input): ErasureEvidenceArtifact;Defined in: src/erasure-evidence.ts:18
Parameters
| Parameter | Type |
|---|---|
input | BuildErasureEvidenceInput |
Returns
compilePolicy()
function compilePolicy(spec, opts?): EntityPolicy;Defined in: src/policy-compiler.ts:22
Parameters
| Parameter | Type |
|---|---|
spec | PolicySpec |
opts | CompileOptions |
Returns
createPagedPrivacyHandler()
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
| Parameter | Type |
|---|---|
options | PagedPrivacyOptions |
Returns
createPagedPrivacyPayload()
function createPagedPrivacyPayload(input): PagedPrivacyPayload & {
[key: string]: JobJson;
};Defined in: src/jobs/paged-privacy.ts:62
Parameters
| Parameter | Type |
|---|---|
input | { registry: Registry; subjectId: string; type: "export" | "erase"; } |
input.registry | Registry |
input.subjectId | string |
input.type | "export" | "erase" |
Returns
PagedPrivacyPayload & { [key: string]: JobJson; }
definePolicy()
function definePolicy(definitions): EntityDefinition[];Defined in: src/policy-definition.ts:14
Parameters
| Parameter | Type |
|---|---|
definitions | readonly EntityDefinition[] |
Returns
erasureEvidenceArtifactKey()
function erasureEvidenceArtifactKey(tenantId, requestId): string;Defined in: src/artifacts.ts:11
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
requestId | string |
Returns
string
exportArtifactKey()
function exportArtifactKey(tenantId, requestId): string;Defined in: src/artifacts.ts:7
Parameters
| Parameter | Type |
|---|---|
tenantId | string |
requestId | string |
Returns
string
formatLintReport()
function formatLintReport(report): string;Defined in: src/lint/lint.ts:454
Parameters
| Parameter | Type |
|---|---|
report | DataSubjectLintReport |
Returns
string
fromPrisma()
function fromPrisma(opts): EntityExecutor;Defined in: src/prisma/from-prisma.ts:27
Parameters
| Parameter | Type |
|---|---|
opts | FromPrismaOptions |
Returns
hashRegistryPolicy()
function hashRegistryPolicy(registry): string;Defined in: src/erasure-plan.ts:82
Parameters
| Parameter | Type |
|---|---|
registry | Registry |
Returns
string
lintPrismaSchema()
function lintPrismaSchema(schemaSource, config?): DataSubjectLintReport;Defined in: src/lint/lint.ts:25
Parameters
| Parameter | Type |
|---|---|
schemaSource | string |
config | DataSubjectLintConfig |
Returns
pagedFromPrisma()
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
| Parameter | Type |
|---|---|
options | PagedFromPrismaOptions |
Returns
parsePrismaSchema()
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
| Parameter | Type |
|---|---|
source | string |
Returns
PrismaSchemaModel[]
sha256Hex()
function sha256Hex(body): string;Defined in: src/artifacts.ts:3
Parameters
| Parameter | Type |
|---|---|
body | string | Buffer<ArrayBufferLike> |
Returns
string
shouldFailLint()
function shouldFailLint(report, failOn): boolean;Defined in: src/lint/lint.ts:463
Parameters
| Parameter | Type |
|---|---|
report | DataSubjectLintReport |
failOn | DataSubjectLintSeverity |
Returns
boolean
validateDefinition()
function validateDefinition(definition): void;Defined in: src/policy-definition.ts:36
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
Returns
void
validateLegalBasis()
function validateLegalBasis(value, opts?): string | null;Defined in: src/legal-basis.ts:7
Parameters
| Parameter | Type |
|---|---|
value | string |
opts | LegalBasisOptions |
Returns
string | null
validateRegistry()
function validateRegistry(registry, opts?): RegistryValidationReport;Defined in: src/registry-validation.ts:20
Parameters
| Parameter | Type |
|---|---|
registry | Registry |
opts | RegistryValidationOptions |
Returns
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