@eresearchqut/ddb-repository 1.5.8 → 1.13.4

package/dist/index.d.cts

@@ -0,0 +1,116 @@
+import { ConsumedCapacity, DynamoDBClient, ReturnConsumedCapacity, ServiceInputTypes, ServiceOutputTypes } from "@aws-sdk/client-dynamodb";
+import { InitializeHandler, InitializeHandlerArguments, InitializeHandlerOutput } from "@smithy/types";
+
+//#region src/DynamoDbRepository.d.ts
+declare enum FilterOperator {
+  EQUALS = "=",
+  NOT_EQUALS = "<>",
+  GREATER_THAN_OR_EQUALS = ">=",
+  GREATER_THAN = ">",
+  LESS_THAN = "<",
+  LESS_THAN_OR_EQUALS = "<=",
+  IN = "IN",
+  BETWEEN = "BETWEEN",
+  BEGINS_WITH = "BEGINS_WITH",
+  CONTAINS = "CONTAINS"
+}
+interface FilterExpression {
+  attribute: string;
+  value: string | number | boolean | Array<string | number> | [string, string] | [number, number];
+  operator: FilterOperator;
+  negate?: boolean;
+}
+interface FilterableQuery {
+  filterExpressions: Array<FilterExpression>;
+}
+interface ProjectedQuery {
+  projectedAttributes: string[];
+}
+interface IndexedQuery {
+  index: string;
+}
+interface Query extends Partial<FilterableQuery>, Partial<ProjectedQuery>, Partial<IndexedQuery> {
+  [key: string]: unknown;
+  filterExpressions?: Array<FilterExpression>;
+  projectedAttributes?: string[];
+  index?: string;
+  sortOrder?: "ASC" | "DESC";
+  limit?: number;
+}
+interface DynamoDbRepositoryOptions {
+  client: DynamoDBClient;
+  tableName: string;
+  hashKey: string;
+  rangeKey?: string;
+  returnConsumedCapacity?: ReturnConsumedCapacity;
+}
+interface PageResult<T> {
+  items: Array<T>;
+  cursor?: string;
+}
+declare class DynamoDbRepository<K, T> {
+  private readonly dynamoDBClient;
+  private readonly tableName;
+  private readonly hashKey;
+  private readonly rangKey?;
+  private readonly returnConsumedCapacity;
+  constructor(options: DynamoDbRepositoryOptions);
+  getItem: (key: K) => Promise<T | undefined>;
+  putItem: (key: K, record: T) => Promise<T>;
+  deleteItem: (key: K) => Promise<T | undefined>;
+  updateItem: (key: K, updates: Partial<T>, remove?: string[]) => Promise<T | undefined>;
+  getItems: (query: Query) => Promise<Array<T> | undefined>;
+  getItemsPage: (query: Query & {
+    cursor?: string;
+  }) => Promise<PageResult<T>>;
+  batchGetItems: (keys: K[], projectedQuery?: ProjectedQuery) => Promise<Array<T | undefined>>;
+  batchWriteItems: (puts: {
+    key: K;
+    item: T;
+  }[], deletes: K[]) => Promise<void>;
+}
+//#endregion
+//#region src/consumed-capacity-middleware.d.ts
+interface ConsumedCapacityDetail {
+  ReturnConsumedCapacity: ReturnConsumedCapacity | undefined;
+  ConsumedCapacity: ConsumedCapacity | ConsumedCapacity[] | undefined;
+}
+interface ConsumedCapacityMiddlewareConfig {
+  onConsumedCapacity: (consumedCapacity: ConsumedCapacityDetail) => Promise<unknown>;
+}
+declare const consumedCapacityMiddleware: (consumedCapacityMiddlewareConfig: ConsumedCapacityMiddlewareConfig) => (next: InitializeHandler<ServiceInputTypes, ServiceOutputTypes>) => (args: InitializeHandlerArguments<ServiceInputTypes>) => Promise<InitializeHandlerOutput<ServiceOutputTypes>>;
+//#endregion
+//#region src/JsonPointerRepository.d.ts
+type JsonPointerValue = string | number | boolean | null;
+interface JsonPointerRepositoryOptions {
+  client: DynamoDBClient;
+  tableName: string;
+  idKey?: string;
+  pointerKey?: string;
+  valueKey?: string;
+  returnConsumedCapacity?: ReturnConsumedCapacity;
+}
+/**
+ * Stores JSON documents as individual per-pointer DynamoDB items addressed by JSON Pointer (RFC 6901).
+ *
+ * Only JSON objects are supported as the root document (`T extends Record<string, unknown>`).
+ * Root arrays and primitives are not supported. Documents must contain at least one leaf value;
+ * empty objects and empty arrays are not supported.
+ */
+declare class JsonPointerRepository<T extends Record<string, unknown>> {
+  private readonly repository;
+  private readonly idKey;
+  private readonly pointerKey;
+  private readonly valueKey;
+  constructor(options: JsonPointerRepositoryOptions);
+  putDocument: (id: string, document: T) => Promise<void>;
+  getDocument: (id: string) => Promise<T | undefined>;
+  getAttribute: <V = JsonPointerValue>(id: string, pointer: string) => Promise<V | undefined>;
+  putAttribute: (id: string, pointer: string, value: JsonPointerValue) => Promise<void>;
+  deleteAttribute: (id: string, pointer: string) => Promise<void>;
+  deleteDocument: (id: string) => Promise<void>;
+  patchDocument: (id: string, updates: Record<string, JsonPointerValue | undefined>) => Promise<void>;
+}
+//#endregion
+export { type ConsumedCapacityDetail, type ConsumedCapacityMiddlewareConfig, DynamoDbRepository, type DynamoDbRepositoryOptions, type FilterExpression, FilterOperator, type FilterableQuery, type IndexedQuery, JsonPointerRepository, type JsonPointerRepositoryOptions, type JsonPointerValue, type PageResult, type ProjectedQuery, type Query, consumedCapacityMiddleware };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,116 @@
+import { ConsumedCapacity, DynamoDBClient, ReturnConsumedCapacity, ServiceInputTypes, ServiceOutputTypes } from "@aws-sdk/client-dynamodb";
+import { InitializeHandler, InitializeHandlerArguments, InitializeHandlerOutput } from "@smithy/types";
+
+//#region src/DynamoDbRepository.d.ts
+declare enum FilterOperator {
+  EQUALS = "=",
+  NOT_EQUALS = "<>",
+  GREATER_THAN_OR_EQUALS = ">=",
+  GREATER_THAN = ">",
+  LESS_THAN = "<",
+  LESS_THAN_OR_EQUALS = "<=",
+  IN = "IN",
+  BETWEEN = "BETWEEN",
+  BEGINS_WITH = "BEGINS_WITH",
+  CONTAINS = "CONTAINS"
+}
+interface FilterExpression {
+  attribute: string;
+  value: string | number | boolean | Array<string | number> | [string, string] | [number, number];
+  operator: FilterOperator;
+  negate?: boolean;
+}
+interface FilterableQuery {
+  filterExpressions: Array<FilterExpression>;
+}
+interface ProjectedQuery {
+  projectedAttributes: string[];
+}
+interface IndexedQuery {
+  index: string;
+}
+interface Query extends Partial<FilterableQuery>, Partial<ProjectedQuery>, Partial<IndexedQuery> {
+  [key: string]: unknown;
+  filterExpressions?: Array<FilterExpression>;
+  projectedAttributes?: string[];
+  index?: string;
+  sortOrder?: "ASC" | "DESC";
+  limit?: number;
+}
+interface DynamoDbRepositoryOptions {
+  client: DynamoDBClient;
+  tableName: string;
+  hashKey: string;
+  rangeKey?: string;
+  returnConsumedCapacity?: ReturnConsumedCapacity;
+}
+interface PageResult<T> {
+  items: Array<T>;
+  cursor?: string;
+}
+declare class DynamoDbRepository<K, T> {
+  private readonly dynamoDBClient;
+  private readonly tableName;
+  private readonly hashKey;
+  private readonly rangKey?;
+  private readonly returnConsumedCapacity;
+  constructor(options: DynamoDbRepositoryOptions);
+  getItem: (key: K) => Promise<T | undefined>;
+  putItem: (key: K, record: T) => Promise<T>;
+  deleteItem: (key: K) => Promise<T | undefined>;
+  updateItem: (key: K, updates: Partial<T>, remove?: string[]) => Promise<T | undefined>;
+  getItems: (query: Query) => Promise<Array<T> | undefined>;
+  getItemsPage: (query: Query & {
+    cursor?: string;
+  }) => Promise<PageResult<T>>;
+  batchGetItems: (keys: K[], projectedQuery?: ProjectedQuery) => Promise<Array<T | undefined>>;
+  batchWriteItems: (puts: {
+    key: K;
+    item: T;
+  }[], deletes: K[]) => Promise<void>;
+}
+//#endregion
+//#region src/consumed-capacity-middleware.d.ts
+interface ConsumedCapacityDetail {
+  ReturnConsumedCapacity: ReturnConsumedCapacity | undefined;
+  ConsumedCapacity: ConsumedCapacity | ConsumedCapacity[] | undefined;
+}
+interface ConsumedCapacityMiddlewareConfig {
+  onConsumedCapacity: (consumedCapacity: ConsumedCapacityDetail) => Promise<unknown>;
+}
+declare const consumedCapacityMiddleware: (consumedCapacityMiddlewareConfig: ConsumedCapacityMiddlewareConfig) => (next: InitializeHandler<ServiceInputTypes, ServiceOutputTypes>) => (args: InitializeHandlerArguments<ServiceInputTypes>) => Promise<InitializeHandlerOutput<ServiceOutputTypes>>;
+//#endregion
+//#region src/JsonPointerRepository.d.ts
+type JsonPointerValue = string | number | boolean | null;
+interface JsonPointerRepositoryOptions {
+  client: DynamoDBClient;
+  tableName: string;
+  idKey?: string;
+  pointerKey?: string;
+  valueKey?: string;
+  returnConsumedCapacity?: ReturnConsumedCapacity;
+}
+/**
+ * Stores JSON documents as individual per-pointer DynamoDB items addressed by JSON Pointer (RFC 6901).
+ *
+ * Only JSON objects are supported as the root document (`T extends Record<string, unknown>`).
+ * Root arrays and primitives are not supported. Documents must contain at least one leaf value;
+ * empty objects and empty arrays are not supported.
+ */
+declare class JsonPointerRepository<T extends Record<string, unknown>> {
+  private readonly repository;
+  private readonly idKey;
+  private readonly pointerKey;
+  private readonly valueKey;
+  constructor(options: JsonPointerRepositoryOptions);
+  putDocument: (id: string, document: T) => Promise<void>;
+  getDocument: (id: string) => Promise<T | undefined>;
+  getAttribute: <V = JsonPointerValue>(id: string, pointer: string) => Promise<V | undefined>;
+  putAttribute: (id: string, pointer: string, value: JsonPointerValue) => Promise<void>;
+  deleteAttribute: (id: string, pointer: string) => Promise<void>;
+  deleteDocument: (id: string) => Promise<void>;
+  patchDocument: (id: string, updates: Record<string, JsonPointerValue | undefined>) => Promise<void>;
+}
+//#endregion
+export { type ConsumedCapacityDetail, type ConsumedCapacityMiddlewareConfig, DynamoDbRepository, type DynamoDbRepositoryOptions, type FilterExpression, FilterOperator, type FilterableQuery, type IndexedQuery, JsonPointerRepository, type JsonPointerRepositoryOptions, type JsonPointerValue, type PageResult, type ProjectedQuery, type Query, consumedCapacityMiddleware };
+//# sourceMappingURL=index.d.mts.map