AppRules

@thotnr-aws-accl/custom-app-api / Exports / AppRules

Class: AppRules

The AppRules class provides methods to manage write validations for application instances. It allows creating, updating, retrieving, and removing validation rules that enforce specific constraints during data write operations.

Table of contents

Methods

• createWriteValidation

• getCurrentLabels

• getCurrentValidations

• removeValidations

• updateWriteValidation

Methods

createWriteValidation

▸ Static createWriteValidation(writeValidation): Promise<WriteValidation>

Creates a new write validation.

Parameters

Name	Type	Description
writeValidation	Object	The WriteValidation object containing the details of the new validation.
writeValidation.writeValidation	WriteValidation	-

Returns

Promise<WriteValidation>

A promise resolving to the ID of the newly created validation.

Example

// Create a new write validation
const newValidationId = await createWriteValidation({
  writeValidation: {
    name: "New Validation",
    description: "Description of the validation",
    externalId: "unique-key",
    errorLevel: WriteValidationErrorLevel.BLOCKER,
    errorMessage: "Error message",
    errorType: 10001,
    objectSqlPredicate: "EXISTS (SELECT * FROM ...)",
    metadata: {},
    isAggregate: true,
    objectId: 789,
    labels: ["labelA", "labelB"],
    enabled: true
  }
});

---

getCurrentLabels

▸ Static getCurrentLabels(): Promise<AppRuleLabel[]>

Retrieve all labels available in the context of the "current" application instance. This typically includes labels from all read/write nodes that reference objects in this instance.

Returns

Promise<AppRuleLabel[]>

---

getCurrentValidations

▸ Static getCurrentValidations(labels): Promise<WriteValidation[]>

Retrieves the current validations for the specified labels.

Parameters

Name	Type	Description
labels	Object	(Optional) A list of labels to filter validations by. If not provided, all validations will be retrieved.
labels.labels?	string[]	-

Returns

Promise<WriteValidation[]>

A promise resolving to an array of WriteValidation objects.

Example

// Retrieve all validations
const validations = await getCurrentValidations({});

Example

// Retrieve validations for specific labels
const validations = await getCurrentValidations({ labels: ['label1', 'label2'] });

---

removeValidations

▸ Static removeValidations(validationId): Promise<number>

Removes a validation by its ID.

Parameters

Name	Type	Description
validationId	Object	The unique ID of the validation to be removed.
validationId.validationId	number	-

Returns

Promise<number>

A promise resolving to the ID of the removed validation.

Example

// Remove a validation with ID 123
const removedValidationId = await removeValidations({ validationId: 123 });

---

updateWriteValidation

▸ Static updateWriteValidation(writeValidation): Promise<WriteValidation>

Updates an existing write validation.

Parameters

Name	Type	Description
writeValidation	Object	The WriteValidation object containing the updated details.
writeValidation.writeValidation	WriteValidation	-

Returns

Promise<WriteValidation>

A promise resolving to the updated validation.

Example

// Update a write validation
const updatedValidationId = await updateWriteValidation({
  writeValidation: {
    id: 123,
    name: "Validation Name",
    description: "Updated validation description",
    externalId: "unique-key",
    errorLevel: WriteValidationErrorLevel.ERROR,
    errorMessage: "Error message",
    errorType: 10001,
    objectSqlPredicate: "EXISTS (SELECT * FROM ...)",
    metadata: {},
    isAggregate: false,
    objectId: 456,
    labels: ["label1", "label2"],
    enabled: true
  }
});