@forge/kvs
1.6.5-experimental-04cc2b91.6.6-next.0
out/interfaces/kvs-api.d.ts~
out/interfaces/kvs-api.d.tsModified+40−40
Index: package/out/interfaces/kvs-api.d.ts
===================================================================
--- package/out/interfaces/kvs-api.d.ts
+++ package/out/interfaces/kvs-api.d.ts
@@ -1,76 +1,76 @@
import { ExtendedSetOptions, GetOptions, MetadataField, SetOptions } from './types';
-type KeySchema = {
+declare type KeySchema = {
key: string;
};
-type KeyValueSchema<T> = KeySchema & {
+declare type KeyValueSchema<T> = KeySchema & {
value: T;
createdAt?: number;
updatedAt?: number;
expireTime?: string;
};
-export type GetRequest = KeySchema & {
+export declare type GetRequest = KeySchema & {
options?: GetOptions;
};
-export type GetResponse<T> = KeyValueSchema<T>;
-export type SetRequest<T> = Pick<KeyValueSchema<T>, 'key' | 'value'> & {
+export declare type GetResponse<T> = KeyValueSchema<T>;
+export declare type SetRequest<T> = Pick<KeyValueSchema<T>, 'key' | 'value'> & {
options?: ExtendedSetOptions;
};
-export type SetResponse<T> = KeyValueSchema<T>;
-export type DeleteRequest = KeySchema;
-type QueryWhere = {
+export declare type SetResponse<T> = KeyValueSchema<T>;
+export declare type DeleteRequest = KeySchema;
+declare type QueryWhere = {
condition: 'BEGINS_WITH';
property: 'key';
values: Array<unknown>;
};
-export type QueryRequest = {
+export declare type QueryRequest = {
limit?: number;
after?: string;
where?: Array<QueryWhere>;
options?: {
metadataFields?: Array<MetadataField>;
};
};
-export type QueryResponse<T> = {
+export declare type QueryResponse<T> = {
data: Array<KeyValueSchema<T>>;
cursor?: string;
};
-export type SecretGetRequest = KeySchema & {
+export declare type SecretGetRequest = KeySchema & {
options?: GetOptions;
};
-export type SecretGetResponse<T> = KeyValueSchema<T>;
-export type SecretSetRequest<T> = KeyValueSchema<T> & {
+export declare type SecretGetResponse<T> = KeyValueSchema<T>;
+export declare type SecretSetRequest<T> = KeyValueSchema<T> & {
options?: ExtendedSetOptions;
};
-export type SecretDeleteRequest = KeySchema;
-type EntityKeySchema = {
+export declare type SecretDeleteRequest = KeySchema;
+declare type EntityKeySchema = {
entityName: string;
key: string;
};
-type EntityKeyValueSchema<T> = EntityKeySchema & {
+declare type EntityKeyValueSchema<T> = EntityKeySchema & {
value: T;
createdAt?: number;
updatedAt?: number;
expireTime?: string;
};
-export type EntityGetRequest = EntityKeySchema & {
+export declare type EntityGetRequest = EntityKeySchema & {
options?: GetOptions;
};
-export type EntityGetResponse<T> = EntityKeyValueSchema<T>;
-export type EntitySetRequest<T> = EntityKeyValueSchema<T> & {
+export declare type EntityGetResponse<T> = EntityKeyValueSchema<T>;
+export declare type EntitySetRequest<T> = EntityKeyValueSchema<T> & {
options?: ExtendedSetOptions;
};
-export type EntityDeleteRequest = EntityKeySchema;
-export type EntityQueryFilter = {
+export declare type EntityDeleteRequest = EntityKeySchema;
+export declare type EntityQueryFilter = {
condition: 'BEGINS_WITH' | 'BETWEEN' | 'CONTAINS' | 'EQUAL_TO' | 'EXISTS' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_EQUAL_TO' | 'NOT_CONTAINS' | 'NOT_EQUAL_TO' | 'NOT_EXISTS';
property: string;
values: Array<unknown>;
};
-export type EntityQueryFilters = {
+export declare type EntityQueryFilters = {
or?: Array<EntityQueryFilter>;
and?: Array<EntityQueryFilter>;
};
-export type EntityQueryRequest = {
+export declare type EntityQueryRequest = {
limit?: number;
cursor?: string;
range?: {
condition: 'BEGINS_WITH' | 'BETWEEN' | 'EQUAL_TO' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_EQUAL_TO';
@@ -82,52 +82,52 @@
entityName: string;
indexName: string;
metadataFields?: Array<MetadataField>;
};
-export type EntityQueryResponse<T> = {
+export declare type EntityQueryResponse<T> = {
data: Array<KeyValueSchema<T>>;
cursor?: string;
};
-export type TransactionCondition = EntityQueryFilters;
-export type RequestSet<T> = {
+export declare type TransactionCondition = EntityQueryFilters;
+export declare type RequestSet<T> = {
key: string;
value: T;
entityName?: string;
conditions?: TransactionCondition;
options?: SetOptions;
};
-export type RequestDelete = {
+export declare type RequestDelete = {
key: string;
entityName?: string;
conditions?: TransactionCondition;
};
-export type RequestCheck = {
+export declare type RequestCheck = {
key: string;
entityName?: string;
conditions: TransactionCondition;
};
-export type TransactionRequest<T> = {
+export declare type TransactionRequest<T> = {
set?: RequestSet<T>[];
delete?: RequestDelete[];
check?: RequestCheck[];
};
-export type BatchSetItem<T> = {
+export declare type BatchSetItem<T> = {
entityName?: string;
key: string;
value: T;
options?: SetOptions;
};
-export type BatchSetRequest<T> = Array<BatchSetItem<T>>;
-export type BatchSetResponse = {
+export declare type BatchSetRequest<T> = Array<BatchSetItem<T>>;
+export declare type BatchSetResponse = {
successfulKeys: BatchItemSuccess[];
failedKeys: BatchItemError[];
};
-export type BatchDeleteItem = {
+export declare type BatchDeleteItem = {
entityName?: string;
key: string;
};
-export type BatchDeleteRequest = Array<BatchDeleteItem>;
-export type BatchDeleteResponse = {
+export declare type BatchDeleteRequest = Array<BatchDeleteItem>;
+export declare type BatchDeleteResponse = {
successfulKeys: BatchItemSuccess[];
failedKeys: BatchItemError[];
};
export interface BatchGetItemResult<T> {
@@ -137,23 +137,23 @@
createdAt?: number;
updatedAt?: number;
expireTime?: string;
}
-export type BatchGetResult<T> = {
+export declare type BatchGetResult<T> = {
successfulKeys: Array<BatchGetItemResult<T>>;
failedKeys: BatchItemError[];
};
-export type BatchGetItem = {
+export declare type BatchGetItem = {
entityName?: string;
key: string;
options?: GetOptions;
};
-export type BatchGetRequest = Array<BatchGetItem>;
-export type BatchItemSuccess = {
+export declare type BatchGetRequest = Array<BatchGetItem>;
+export declare type BatchItemSuccess = {
key: string;
entityName?: string;
};
-export type BatchItemError = {
+export declare type BatchItemError = {
key: string;
entityName?: string;
error: {
code: string;