@or-sdk/key-value-storage 0.28.0 → 0.28.1-beta.4013.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,28 +5,167 @@ export declare class KeyValueStorage {
5
5
  private readonly sdkApi;
6
6
  constructor(params: KeyValueStorageConfig);
7
7
  composeRoute(route: string): string;
8
+ /**
9
+ * List collections with pagination
10
+ *
11
+ * ```typescript
12
+ * const prefix = '__some_prefix';
13
+ * const numberOfItems = 30;
14
+ * const nextId = 'next-token'; // next page token from previous listCollectionsPaginated call
15
+ * const list = await keyValueStorage.scrollCollections({numberOfItems, nextId}, prefix);
16
+ * ```
17
+ */
8
18
  scrollCollections({ numberOfItems, nextId }: ScrollOptions, prefix?: string): Promise<ScrollResult<string>>;
19
+ /**
20
+ * List collections
21
+ *
22
+ * ```typescript
23
+ * const prefix = '__some_prefix';
24
+ * const list = await keyValueStorage.listCollections(prefix);
25
+ * ```
26
+ */
9
27
  listCollections(prefix?: string): Promise<List<string>>;
28
+ /**
29
+ * List keys grouped by prefix in a collection starting with given substring with pagination
30
+ *
31
+ * ```typescript
32
+ * const collectionName = 'my-collection';
33
+ * const prefix = '__some_prefix';
34
+ * const numberOfItems = 30;
35
+ * const nextId = 'next-token'; // next page token from previous listKeysPaginated call
36
+ * const stripPrefix = true; // removes parent prefix
37
+ * const list = await keyValueStorage.scrollKeysWithPrefixes(
38
+ * { numberOfItems, nextId },
39
+ * collectionName,
40
+ * prefix,
41
+ * stripPrefix,
42
+ * );
43
+ * ```
44
+ */
10
45
  scrollKeysWithPrefixes({ numberOfItems, nextId }: ScrollOptions, collectionName: string, prefix?: string, stripPrefix?: boolean): Promise<ScrollResult<KeyValueStoragePrefix>>;
46
+ /**
47
+ * List all unique keys or key parts (till nearest `/` in key) in a collection starting with given prefix
48
+ *
49
+ * ```typescript
50
+ * const collectionName = 'my-collection';
51
+ * const prefix = '__some_prefix';
52
+ * const stripPrefix = true; // removes parent prefix
53
+ * const list = await keyValueStorage.listUniqueKeysWithPrefixes(collectionName, prefix, stripPrefix);
54
+ * ```
55
+ *
56
+ * @param collectionName name of the collection
57
+ * @param prefix optional prefix to filter keys
58
+ * @param stripPrefix if true remove prefix from result keys
59
+ */
11
60
  listUniqueKeysWithPrefixes(collectionName: string, prefix?: string, stripPrefix?: boolean): Promise<List<string>>;
61
+ /**
62
+ * List keys in a collection starting with given substring with pagination
63
+ *
64
+ * ```typescript
65
+ * const collectionName = 'my-collection';
66
+ * const prefix = '__some_prefix';
67
+ * const withValues = false; // set to true to receive record values alongside key names
68
+ * const numberOfItems = 30;
69
+ * const nextId = 'next-token'; // next page token from previous listKeysPaginated call
70
+ * const list = await keyValueStorage.scrollKeys({ numberOfItems, nextId }, collectionName, prefix, withValues);
71
+ * ```
72
+ */
12
73
  scrollKeys<T>(options: ScrollOptions, collectionName: string): Promise<ScrollResult<ListKeysRecord>>;
13
74
  scrollKeys<T>(options: ScrollOptions, collectionName: string, prefix?: string): Promise<ScrollResult<ListKeysRecord>>;
14
75
  scrollKeys<T>(options: ScrollOptions, collectionName: string, prefix?: string, withValues?: false): Promise<ScrollResult<ListKeysRecord>>;
15
76
  scrollKeys<T>(options: ScrollOptions, collectionName: string, prefix?: string, withValues?: true): Promise<ScrollResult<ListKeysRecordWithValue<T>>>;
16
77
  scrollKeys<T>(options: ScrollOptions, collectionName: string, prefix?: string, withValues?: boolean): Promise<ScrollResult<ListKeysRecord | ListKeysRecordWithValue<T>>>;
78
+ /**
79
+ * List keys in a collection starting with given substring
80
+ *
81
+ * ```typescript
82
+ * const collectionName = 'my-collection';
83
+ * const prefix = '__some_prefix';
84
+ * const withValues = false; // set to true to receive record values alongside key names
85
+ * const list = await keyValueStorage.listKeys(collectionName, prefix, withValues);
86
+ * ```
87
+ */
17
88
  listKeys<T>(collectionName: string): Promise<List<ListKeysRecord>>;
18
89
  listKeys<T>(collectionName: string, prefix?: string): Promise<List<ListKeysRecord>>;
19
90
  listKeys<T>(collectionName: string, prefix?: string, withValues?: false): Promise<List<ListKeysRecord>>;
20
91
  listKeys<T>(collectionName: string, prefix?: string, withValues?: true): Promise<List<ListKeysRecordWithValue<T>>>;
92
+ /**
93
+ * Check if value with the key exists in the collection
94
+ *
95
+ * ```typescript
96
+ * const collectionName = 'my-collection';
97
+ * const key = 'my-key';
98
+ * const exists = await keyValueStorage.existsValueByKey(collectionName, key);
99
+ * ```
100
+ */
21
101
  existsValueByKey(collectionName: string, key: string): Promise<boolean>;
102
+ /**
103
+ * Get value from collection by key
104
+ *
105
+ * ```typescript
106
+ * const collectionName = 'my-collection';
107
+ * const key = 'my-key';
108
+ * const record = await keyValueStorage.getValueByKey(collectionName, key);
109
+ * ```
110
+ */
22
111
  getValueByKey<T = KeyValueStorageValue>(collectionName: string, key: string): Promise<KeyValueStorageRecord<T>>;
112
+ /**
113
+ * Set value to collection by key
114
+ *
115
+ * ```typescript
116
+ * const collectionName = 'my-collection';
117
+ * const key = 'my-key';
118
+ * const value = { 'prop': 'value' };
119
+ * const expire = 300000; // time before record deletion in milliseconds
120
+ * await keyValueStorage.setValueByKey(collectionName, key, value, expire);
121
+ * ```
122
+ */
23
123
  setValueByKey<T>(collectionName: string, key: string, value: T extends undefined ? never : T, expire?: number): Promise<SetValueResponse<T>>;
124
+ /**
125
+ * Delete a key from a collection
126
+ *
127
+ * ```typescript
128
+ * const collectionName = 'my-collection';
129
+ * const key = 'my-key';
130
+ * const record = await keyValueStorage.deleteKey(collectionName, key);
131
+ * ```
132
+ */
24
133
  deleteKey(collectionName: string, key: string): Promise<void>;
134
+ /**
135
+ * Process multiple records
136
+ *
137
+ * ```typescript
138
+ * const collectionName = 'my-collection';
139
+ * const records = [{ key: 'new-key', value: 'new-value' }]; // array of records to process, max 10
140
+ * const action = 'set'; // [ get, set, delete, exists ]
141
+ * const result = await keyValueStorage.processMultipleRecords(records, action, collectionName);
142
+ * ```
143
+ */
25
144
  processMultipleRecords<T>(records: KeyValueStorageRecord[], action: Action.GET, collectionName: string): Promise<GetValueResponse<T>[]>;
26
145
  processMultipleRecords<T>(records: KeyValueStorageRecord[], action: Action.SET, collectionName: string): Promise<SetValueResponse<T>[]>;
27
146
  processMultipleRecords<T>(records: KeyValueStorageRecord[], action: Action.DELETE, collectionName: string): Promise<DeleteValueResponse<T>[]>;
28
147
  processMultipleRecords<T>(records: KeyValueStorageRecord[], action: Action.EXISTS, collectionName: string): Promise<ExistsValueResponse[]>;
148
+ /**
149
+ * Copy records from one collection to another
150
+ *
151
+ * Existing records in the target collection will be preserved
152
+ * unless they have matching keys with records from the source collection
153
+ *
154
+ * ```typescript
155
+ * const sourceCollectionName = 'old-collection';
156
+ * const targetCollectionName = 'new-collection';
157
+ * const await keyValueStorage.copyCollection(sourceCollectionName, targetCollectionName);
158
+ * ```
159
+ */
29
160
  copyCollection<T = KeyValueStorageValue>(sourceCollectionName: string, targetCollectionName: string): Promise<void>;
161
+ /**
162
+ * Delete all records from collection
163
+ *
164
+ * ```typescript
165
+ * const collectionName = 'collection';
166
+ * const await keyValueStorage.clearCollection(collectionName);
167
+ * ```
168
+ */
30
169
  clearCollection<T = KeyValueStorageValue>(collectionName: string): Promise<void>;
31
170
  }
32
171
  //# sourceMappingURL=KeyValueStorage.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"KeyValueStorage.d.ts","sourceRoot":"","sources":["../../src/KeyValueStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,MAAM,EAAyC,MAAM,aAAa,CAAC;AAC5E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EAIrB,aAAa,EACb,YAAY,EACZ,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAGjB,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,qBAAqB;IAWzC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IActB,iBAAiB,CAC5B,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,aAAa,EACxC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IA4BnB,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IA8BvD,sBAAsB,CACjC,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,aAAa,EACxC,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,YAAY,CAAE,qBAAqB,CAAE,CAAC;IAoCpC,0BAA0B,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,IAAI,CAAE,MAAM,CAAE,CAAC;IAkCb,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IACtG,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IACvH,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IAC3I,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAE,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IACtJ,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IA2C1K,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACpE,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACrF,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACzG,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAE,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IAoCpH,gBAAgB,CAC3B,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,CAAC;IAiBN,aAAa,CAAC,CAAC,GAAC,oBAAoB,EAC/C,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAkBvB,aAAa,CAAC,CAAC,EAC1B,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,EACtC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAoBlB,SAAS,CACpB,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC;IAoBH,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IACvI,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IACvI,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7I,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAgC1I,cAAc,CAAC,CAAC,GAAC,oBAAoB,EAChD,oBAAoB,EAAE,MAAM,EAC5B,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAAC,IAAI,CAAC;IAkBH,eAAe,CAAC,CAAC,GAAC,oBAAoB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAS5F"}
1
+ {"version":3,"file":"KeyValueStorage.d.ts","sourceRoot":"","sources":["../../src/KeyValueStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,MAAM,EAAyC,MAAM,aAAa,CAAC;AAC5E,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EAIrB,aAAa,EACb,YAAY,EACZ,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAGjB,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,qBAAqB;IAWzC,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAInC;;;;;;;;;OASG;IACU,iBAAiB,CAC5B,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,aAAa,EACxC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAoBhC;;;;;;;OAOG;IACU,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAapE;;;;;;;;;;;;;;;;OAgBG;IACU,sBAAsB,CACjC,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,aAAa,EACxC,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,YAAY,CAAE,qBAAqB,CAAE,CAAC;IAsBjD;;;;;;;;;;;;;OAaG;IACU,0BAA0B,CACrC,cAAc,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,WAAW,CAAC,EAAE,OAAO,GACpB,OAAO,CAAC,IAAI,CAAE,MAAM,CAAE,CAAC;IAmB1B;;;;;;;;;;;OAWG;IAIU,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IACtG,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IACvH,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,CAAE,CAAC;IAC3I,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,YAAY,CAAE,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IACtJ,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAE,cAAc,GAAG,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IA8BvL;;;;;;;;;OASG;IAIU,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACpE,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACrF,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAE,cAAc,CAAE,CAAC;IACzG,QAAQ,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAE,uBAAuB,CAAC,CAAC,CAAC,CAAE,CAAC;IA2BjI;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;OAQG;IACU,aAAa,CAAC,CAAC,GAAC,oBAAoB,EAC/C,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAOpC;;;;;;;;;;OAUG;IACU,aAAa,CAAC,CAAC,EAC1B,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,EACtC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAW/B;;;;;;;;OAQG;IACU,SAAS,CACpB,cAAc,EAAE,MAAM,EACtB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;;OASG;IAIU,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IACvI,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IACvI,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7I,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAoBvJ;;;;;;;;;;;OAWG;IACU,cAAc,CAAC,CAAC,GAAC,oBAAoB,EAChD,oBAAoB,EAAE,MAAM,EAC5B,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;;;;OAOG;IACU,eAAe,CAAC,CAAC,GAAC,oBAAoB,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAS5F"}
@@ -1,9 +1,21 @@
1
1
  import { List, Token } from '@or-sdk/base';
2
2
  type Merge<T> = Omit<T, never>;
3
3
  export type KeyValueStorageConfig = {
4
+ /**
5
+ * token
6
+ */
4
7
  token: Token;
8
+ /**
9
+ * Url of OneReach service discovery api
10
+ */
5
11
  discoveryUrl?: string;
12
+ /**
13
+ * Account ID for cross-account requests (super admin only)
14
+ */
6
15
  accountId?: string;
16
+ /**
17
+ * Url of OneReach SDK api
18
+ */
7
19
  sdkUrl?: string;
8
20
  };
9
21
  export type KeyValueStoragePrefix = {
@@ -11,6 +23,9 @@ export type KeyValueStoragePrefix = {
11
23
  };
12
24
  export type KeyValueStorageValue = unknown;
13
25
  export type KeyValueStorageRecord<T = KeyValueStorageValue> = {
26
+ /**
27
+ * Record key
28
+ */
14
29
  key: string;
15
30
  value?: T;
16
31
  };
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE3C,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAE/B,MAAM,MAAM,qBAAqB,GAAG;IAIlC,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAG3C,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAI1D,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,CAAC,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AACF,MAAM,MAAM,uBAAuB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,qCAAqC,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IACrD,KAAK,EAAE;QACL,OAAO,EAAE,cAAc,EAAE,GAAG,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,WAAW,EAAE,OAAO,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE;QACL,OAAO,EAAE,qBAAqB,EAAE,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjG,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1F,MAAM,MAAM,mBAAmB,GAAG,KAAK,CACvC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG;IACrC,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAC,oBAAoB,IAAI,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAC/E,gBAAgB,CAAC,CAAC,CAAC,EAAE,GACrB,mBAAmB,CAAC,CAAC,CAAC,EAAE,GACxB,mBAAmB,EAAE,GACrB,OAAO,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE3C,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAE/B,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAG3C,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAC1D;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,CAAC,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AACF,MAAM,MAAM,uBAAuB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAC5D,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,qCAAqC,CAAC,CAAC,GAAC,oBAAoB,IAAI;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI;IACrD,KAAK,EAAE;QACL,OAAO,EAAE,cAAc,EAAE,GAAG,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,WAAW,EAAE,OAAO,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE;QACL,OAAO,EAAE,qBAAqB,EAAE,CAAC;QACjC,WAAW,EAAE,OAAO,CAAC;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AACF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjG,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAC,oBAAoB,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1F,MAAM,MAAM,mBAAmB,GAAG,KAAK,CACvC,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG;IACrC,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG;IAC5C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAC,oBAAoB,IAAI,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAC/E,gBAAgB,CAAC,CAAC,CAAC,EAAE,GACrB,mBAAmB,CAAC,CAAC,CAAC,EAAE,GACxB,mBAAmB,EAAE,GACrB,OAAO,CAAC"}
@@ -1,2 +1,5 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export * from './chunk';
2
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAGA,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,SAAS,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/key-value-storage",
3
- "version": "0.28.0",
3
+ "version": "0.28.1-beta.4013.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -18,8 +18,8 @@
18
18
  "dev": "pnpm build:watch:esm"
19
19
  },
20
20
  "dependencies": {
21
- "@or-sdk/base": "^0.43.0",
22
- "@or-sdk/sdk-api": "^0.27.0"
21
+ "@or-sdk/base": "^0.44.0-beta.4013.0",
22
+ "@or-sdk/sdk-api": "^0.28.0-beta.4013.0"
23
23
  },
24
24
  "devDependencies": {
25
25
  "concurrently": "9.0.1",
@@ -27,6 +27,5 @@
27
27
  },
28
28
  "publishConfig": {
29
29
  "access": "public"
30
- },
31
- "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
30
+ }
32
31
  }