cbl-ionic 0.2.4

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.
Files changed (190) hide show
  1. package/CblIonic.podspec +18 -0
  2. package/LICENSE +201 -0
  3. package/README.md +19 -0
  4. package/android/build.gradle +69 -0
  5. package/android/src/main/AndroidManifest.xml +2 -0
  6. package/android/src/main/java/cbl/js/kotiln/CollectionConfigDto.kt +5 -0
  7. package/android/src/main/java/cbl/js/kotiln/CollectionDocumentResult.kt +7 -0
  8. package/android/src/main/java/cbl/js/kotiln/CollectionDto.kt +9 -0
  9. package/android/src/main/java/cbl/js/kotiln/CollectionManager.kt +232 -0
  10. package/android/src/main/java/cbl/js/kotiln/ConfigDto.kt +5 -0
  11. package/android/src/main/java/cbl/js/kotiln/DatabaseManager.kt +183 -0
  12. package/android/src/main/java/cbl/js/kotiln/DocumentDto.kt +6 -0
  13. package/android/src/main/java/cbl/js/kotiln/FileSystemHelper.kt +18 -0
  14. package/android/src/main/java/cbl/js/kotiln/LoggingManager.kt +30 -0
  15. package/android/src/main/java/cbl/js/kotiln/ReplicatorManager.kt +123 -0
  16. package/android/src/main/java/cbl/js/kotiln/ScopeDto.kt +6 -0
  17. package/android/src/main/java/com/couchbase/ionic/CblIonicPluginPlugin.kt +1832 -0
  18. package/android/src/main/java/com/couchbase/ionic/IndexDto.kt +12 -0
  19. package/android/src/main/java/com/couchbase/ionic/IndexHelper.kt +30 -0
  20. package/android/src/main/java/com/couchbase/ionic/PluginHelper.kt +283 -0
  21. package/android/src/main/java/com/couchbase/ionic/QueryHelper.kt +62 -0
  22. package/android/src/main/java/com/couchbase/ionic/ReplicatorHelper.kt +174 -0
  23. package/android/src/main/res/.gitkeep +0 -0
  24. package/dist/esm/cblite-js/cblite/core-types.d.ts +634 -0
  25. package/dist/esm/cblite-js/cblite/core-types.js +2 -0
  26. package/dist/esm/cblite-js/cblite/core-types.js.map +1 -0
  27. package/dist/esm/cblite-js/cblite/index.d.ts +2 -0
  28. package/dist/esm/cblite-js/cblite/index.js +4 -0
  29. package/dist/esm/cblite-js/cblite/index.js.map +1 -0
  30. package/dist/esm/cblite-js/cblite/src/abstract-index.d.ts +14 -0
  31. package/dist/esm/cblite-js/cblite/src/abstract-index.js +12 -0
  32. package/dist/esm/cblite-js/cblite/src/abstract-index.js.map +1 -0
  33. package/dist/esm/cblite-js/cblite/src/authenticator.d.ts +6 -0
  34. package/dist/esm/cblite-js/cblite/src/authenticator.js +3 -0
  35. package/dist/esm/cblite-js/cblite/src/authenticator.js.map +1 -0
  36. package/dist/esm/cblite-js/cblite/src/basic-authenticator.d.ts +42 -0
  37. package/dist/esm/cblite-js/cblite/src/basic-authenticator.js +59 -0
  38. package/dist/esm/cblite-js/cblite/src/basic-authenticator.js.map +1 -0
  39. package/dist/esm/cblite-js/cblite/src/blob.d.ts +58 -0
  40. package/dist/esm/cblite-js/cblite/src/blob.js +86 -0
  41. package/dist/esm/cblite-js/cblite/src/blob.js.map +1 -0
  42. package/dist/esm/cblite-js/cblite/src/collation.d.ts +20 -0
  43. package/dist/esm/cblite-js/cblite/src/collation.js +64 -0
  44. package/dist/esm/cblite-js/cblite/src/collation.js.map +1 -0
  45. package/dist/esm/cblite-js/cblite/src/collection-config.d.ts +24 -0
  46. package/dist/esm/cblite-js/cblite/src/collection-config.js +30 -0
  47. package/dist/esm/cblite-js/cblite/src/collection-config.js.map +1 -0
  48. package/dist/esm/cblite-js/cblite/src/collection.d.ts +189 -0
  49. package/dist/esm/cblite-js/cblite/src/collection.js +354 -0
  50. package/dist/esm/cblite-js/cblite/src/collection.js.map +1 -0
  51. package/dist/esm/cblite-js/cblite/src/concurrency-control.d.ts +4 -0
  52. package/dist/esm/cblite-js/cblite/src/concurrency-control.js +8 -0
  53. package/dist/esm/cblite-js/cblite/src/concurrency-control.js.map +1 -0
  54. package/dist/esm/cblite-js/cblite/src/couchbase-lite-exception.d.ts +6 -0
  55. package/dist/esm/cblite-js/cblite/src/couchbase-lite-exception.js +15 -0
  56. package/dist/esm/cblite-js/cblite/src/couchbase-lite-exception.js.map +1 -0
  57. package/dist/esm/cblite-js/cblite/src/database-configuration.d.ts +52 -0
  58. package/dist/esm/cblite-js/cblite/src/database-configuration.js +75 -0
  59. package/dist/esm/cblite-js/cblite/src/database-configuration.js.map +1 -0
  60. package/dist/esm/cblite-js/cblite/src/database-logging.d.ts +13 -0
  61. package/dist/esm/cblite-js/cblite/src/database-logging.js +13 -0
  62. package/dist/esm/cblite-js/cblite/src/database-logging.js.map +1 -0
  63. package/dist/esm/cblite-js/cblite/src/database.d.ts +254 -0
  64. package/dist/esm/cblite-js/cblite/src/database.js +514 -0
  65. package/dist/esm/cblite-js/cblite/src/database.js.map +1 -0
  66. package/dist/esm/cblite-js/cblite/src/definitions.d.ts +7 -0
  67. package/dist/esm/cblite-js/cblite/src/definitions.js +2 -0
  68. package/dist/esm/cblite-js/cblite/src/definitions.js.map +1 -0
  69. package/dist/esm/cblite-js/cblite/src/document-replication.d.ts +13 -0
  70. package/dist/esm/cblite-js/cblite/src/document-replication.js +34 -0
  71. package/dist/esm/cblite-js/cblite/src/document-replication.js.map +1 -0
  72. package/dist/esm/cblite-js/cblite/src/document.d.ts +199 -0
  73. package/dist/esm/cblite-js/cblite/src/document.js +333 -0
  74. package/dist/esm/cblite-js/cblite/src/document.js.map +1 -0
  75. package/dist/esm/cblite-js/cblite/src/endpoint.d.ts +3 -0
  76. package/dist/esm/cblite-js/cblite/src/endpoint.js +2 -0
  77. package/dist/esm/cblite-js/cblite/src/endpoint.js.map +1 -0
  78. package/dist/esm/cblite-js/cblite/src/engine-locator.d.ts +42 -0
  79. package/dist/esm/cblite-js/cblite/src/engine-locator.js +50 -0
  80. package/dist/esm/cblite-js/cblite/src/engine-locator.js.map +1 -0
  81. package/dist/esm/cblite-js/cblite/src/expression.d.ts +134 -0
  82. package/dist/esm/cblite-js/cblite/src/expression.js +374 -0
  83. package/dist/esm/cblite-js/cblite/src/expression.js.map +1 -0
  84. package/dist/esm/cblite-js/cblite/src/file-system.d.ts +7 -0
  85. package/dist/esm/cblite-js/cblite/src/file-system.js +14 -0
  86. package/dist/esm/cblite-js/cblite/src/file-system.js.map +1 -0
  87. package/dist/esm/cblite-js/cblite/src/full-text-expression.d.ts +28 -0
  88. package/dist/esm/cblite-js/cblite/src/full-text-expression.js +38 -0
  89. package/dist/esm/cblite-js/cblite/src/full-text-expression.js.map +1 -0
  90. package/dist/esm/cblite-js/cblite/src/full-text-index.d.ts +47 -0
  91. package/dist/esm/cblite-js/cblite/src/full-text-index.js +77 -0
  92. package/dist/esm/cblite-js/cblite/src/full-text-index.js.map +1 -0
  93. package/dist/esm/cblite-js/cblite/src/index-builder.d.ts +20 -0
  94. package/dist/esm/cblite-js/cblite/src/index-builder.js +25 -0
  95. package/dist/esm/cblite-js/cblite/src/index-builder.js.map +1 -0
  96. package/dist/esm/cblite-js/cblite/src/index.d.ts +42 -0
  97. package/dist/esm/cblite-js/cblite/src/index.js +43 -0
  98. package/dist/esm/cblite-js/cblite/src/index.js.map +1 -0
  99. package/dist/esm/cblite-js/cblite/src/meta-expression.d.ts +10 -0
  100. package/dist/esm/cblite-js/cblite/src/meta-expression.js +30 -0
  101. package/dist/esm/cblite-js/cblite/src/meta-expression.js.map +1 -0
  102. package/dist/esm/cblite-js/cblite/src/meta.d.ts +7 -0
  103. package/dist/esm/cblite-js/cblite/src/meta.js +8 -0
  104. package/dist/esm/cblite-js/cblite/src/meta.js.map +1 -0
  105. package/dist/esm/cblite-js/cblite/src/mutable-document.d.ts +373 -0
  106. package/dist/esm/cblite-js/cblite/src/mutable-document.js +481 -0
  107. package/dist/esm/cblite-js/cblite/src/mutable-document.js.map +1 -0
  108. package/dist/esm/cblite-js/cblite/src/ordering.d.ts +14 -0
  109. package/dist/esm/cblite-js/cblite/src/ordering.js +31 -0
  110. package/dist/esm/cblite-js/cblite/src/ordering.js.map +1 -0
  111. package/dist/esm/cblite-js/cblite/src/parameter.d.ts +18 -0
  112. package/dist/esm/cblite-js/cblite/src/parameter.js +38 -0
  113. package/dist/esm/cblite-js/cblite/src/parameter.js.map +1 -0
  114. package/dist/esm/cblite-js/cblite/src/parameters.d.ts +17 -0
  115. package/dist/esm/cblite-js/cblite/src/parameters.js +61 -0
  116. package/dist/esm/cblite-js/cblite/src/parameters.js.map +1 -0
  117. package/dist/esm/cblite-js/cblite/src/query.d.ts +83 -0
  118. package/dist/esm/cblite-js/cblite/src/query.js +146 -0
  119. package/dist/esm/cblite-js/cblite/src/query.js.map +1 -0
  120. package/dist/esm/cblite-js/cblite/src/replicated-document.d.ts +25 -0
  121. package/dist/esm/cblite-js/cblite/src/replicated-document.js +51 -0
  122. package/dist/esm/cblite-js/cblite/src/replicated-document.js.map +1 -0
  123. package/dist/esm/cblite-js/cblite/src/replicator-activity-level.d.ts +7 -0
  124. package/dist/esm/cblite-js/cblite/src/replicator-activity-level.js +14 -0
  125. package/dist/esm/cblite-js/cblite/src/replicator-activity-level.js.map +1 -0
  126. package/dist/esm/cblite-js/cblite/src/replicator-change.d.ts +14 -0
  127. package/dist/esm/cblite-js/cblite/src/replicator-change.js +14 -0
  128. package/dist/esm/cblite-js/cblite/src/replicator-change.js.map +1 -0
  129. package/dist/esm/cblite-js/cblite/src/replicator-configuration.d.ts +341 -0
  130. package/dist/esm/cblite-js/cblite/src/replicator-configuration.js +516 -0
  131. package/dist/esm/cblite-js/cblite/src/replicator-configuration.js.map +1 -0
  132. package/dist/esm/cblite-js/cblite/src/replicator-progress.d.ts +9 -0
  133. package/dist/esm/cblite-js/cblite/src/replicator-progress.js +20 -0
  134. package/dist/esm/cblite-js/cblite/src/replicator-progress.js.map +1 -0
  135. package/dist/esm/cblite-js/cblite/src/replicator-status.d.ts +13 -0
  136. package/dist/esm/cblite-js/cblite/src/replicator-status.js +29 -0
  137. package/dist/esm/cblite-js/cblite/src/replicator-status.js.map +1 -0
  138. package/dist/esm/cblite-js/cblite/src/replicator.d.ts +108 -0
  139. package/dist/esm/cblite-js/cblite/src/replicator.js +224 -0
  140. package/dist/esm/cblite-js/cblite/src/replicator.js.map +1 -0
  141. package/dist/esm/cblite-js/cblite/src/result.d.ts +4 -0
  142. package/dist/esm/cblite-js/cblite/src/result.js +2 -0
  143. package/dist/esm/cblite-js/cblite/src/result.js.map +1 -0
  144. package/dist/esm/cblite-js/cblite/src/scope.d.ts +31 -0
  145. package/dist/esm/cblite-js/cblite/src/scope.js +34 -0
  146. package/dist/esm/cblite-js/cblite/src/scope.js.map +1 -0
  147. package/dist/esm/cblite-js/cblite/src/session-authenticator.d.ts +32 -0
  148. package/dist/esm/cblite-js/cblite/src/session-authenticator.js +52 -0
  149. package/dist/esm/cblite-js/cblite/src/session-authenticator.js.map +1 -0
  150. package/dist/esm/cblite-js/cblite/src/url-endpoint.d.ts +8 -0
  151. package/dist/esm/cblite-js/cblite/src/url-endpoint.js +12 -0
  152. package/dist/esm/cblite-js/cblite/src/url-endpoint.js.map +1 -0
  153. package/dist/esm/cblite-js/cblite/src/value-index.d.ts +32 -0
  154. package/dist/esm/cblite-js/cblite/src/value-index.js +54 -0
  155. package/dist/esm/cblite-js/cblite/src/value-index.js.map +1 -0
  156. package/dist/esm/cblite-js/cblite/src/variable-expression.d.ts +7 -0
  157. package/dist/esm/cblite-js/cblite/src/variable-expression.js +15 -0
  158. package/dist/esm/cblite-js/cblite/src/variable-expression.js.map +1 -0
  159. package/dist/esm/couchbase-lite/capacitor-engine.d.ts +124 -0
  160. package/dist/esm/couchbase-lite/capacitor-engine.js +303 -0
  161. package/dist/esm/couchbase-lite/capacitor-engine.js.map +1 -0
  162. package/dist/esm/definitions.d.ts +12 -0
  163. package/dist/esm/definitions.js +4 -0
  164. package/dist/esm/definitions.js.map +1 -0
  165. package/dist/esm/index.d.ts +4 -0
  166. package/dist/esm/index.js +5 -0
  167. package/dist/esm/index.js.map +1 -0
  168. package/dist/esm/ionic-couchbase-lite.d.ts +3 -0
  169. package/dist/esm/ionic-couchbase-lite.js +4 -0
  170. package/dist/esm/ionic-couchbase-lite.js.map +1 -0
  171. package/dist/plugin.cjs.js +4400 -0
  172. package/dist/plugin.cjs.js.map +1 -0
  173. package/dist/plugin.js +4403 -0
  174. package/dist/plugin.js.map +1 -0
  175. package/ios/Plugin/CblIonicPlugin.swift +1583 -0
  176. package/ios/Plugin/CblIonicPluginPlugin.h +10 -0
  177. package/ios/Plugin/CblIonicPluginPlugin.m +86 -0
  178. package/ios/Plugin/Info.plist +24 -0
  179. package/ios/Plugin/cbl-js-swift/CollectionManager.swift +489 -0
  180. package/ios/Plugin/cbl-js-swift/DatabaseManager.swift +319 -0
  181. package/ios/Plugin/cbl-js-swift/FileSystemHelper.swift +22 -0
  182. package/ios/Plugin/cbl-js-swift/IndexHelper.swift +36 -0
  183. package/ios/Plugin/cbl-js-swift/LICENSE +201 -0
  184. package/ios/Plugin/cbl-js-swift/LoggingManager.swift +79 -0
  185. package/ios/Plugin/cbl-js-swift/MapHelper.swift +92 -0
  186. package/ios/Plugin/cbl-js-swift/QueryHelper.swift +74 -0
  187. package/ios/Plugin/cbl-js-swift/README.md +9 -0
  188. package/ios/Plugin/cbl-js-swift/ReplicatorHelper.swift +184 -0
  189. package/ios/Plugin/cbl-js-swift/ReplicatorManager.swift +157 -0
  190. package/package.json +86 -0
@@ -0,0 +1,634 @@
1
+ import { AbstractIndex, Collection, ConcurrencyControl, Database, DatabaseConfiguration, DatabaseFileLoggingConfiguration, DocumentReplicationRepresentation, Dictionary, Document, MaintenanceType, Query, ReplicatorStatus, Result, ResultSet, Scope } from './src';
2
+ /**
3
+ * Represents the data that is returned from a listener callback
4
+ *
5
+ * @interface
6
+ */
7
+ export interface CallbackResultData {
8
+ [key: string]: any;
9
+ }
10
+ /**
11
+ * Represents any error messages that is returned from a listener callback
12
+ *
13
+ * @interface
14
+ */
15
+ export interface CallbackResultError {
16
+ message: string;
17
+ }
18
+ /**
19
+ * Represents a Collection argument
20
+ *
21
+ * This interface is used to return the arguments
22
+ * for getting a Collection from a Database
23
+ *
24
+ * @interface
25
+ * @property {string} name - The unique name of the database
26
+ * @property {string} scopeName - The unique name of the Scope
27
+ * @property {string} collectionName - The unique name of the Collection
28
+ */
29
+ export interface CollectionArgs {
30
+ name: string;
31
+ scopeName: string;
32
+ collectionName: string;
33
+ }
34
+ /**
35
+ * Represents a change in a collection.
36
+ *
37
+ * This interface is used to return a set of documents
38
+ * that have changed from a change listener
39
+ *
40
+ * @interface
41
+ * @property {string[]} documentIds - The unique identifier for each document
42
+ */
43
+ export interface CollectionChange {
44
+ documentIDs: string[];
45
+ }
46
+ export type CollectionChangeListener = (change: CollectionChange) => void;
47
+ /**
48
+ * Represents arguments in a change in a collection.
49
+ *
50
+ * This interface is used set up a collection change listener
51
+ *
52
+ * @interface
53
+ */
54
+ export interface CollectionChangeListenerArgs extends CollectionArgs {
55
+ changeListenerToken: string;
56
+ }
57
+ /**
58
+ * Represents arguments for a creating an Index
59
+ *
60
+ * This interface is used to return the arguments
61
+ * for creating an Index in a Collection
62
+ *
63
+ * @interface
64
+ * @property {string} name - The unique name of the database
65
+ * @property {string} scopeName - The unique name of the Scope
66
+ * @property {string} collectionName - The unique name of the Collection
67
+ * @property {string} indexName - The unique name of the database
68
+ * @property {string} index - The abstract index to create
69
+ */
70
+ export interface CollectionCreateIndexArgs extends CollectionArgs {
71
+ indexName: string;
72
+ index: AbstractIndex;
73
+ }
74
+ /**
75
+ * Represents arguments for a deleting a document from a collection
76
+ *
77
+ * This interface is used to return the arguments
78
+ * for deleting a document from a Collection
79
+ *
80
+ * @interface
81
+ * @property {string} name - The unique name of the database
82
+ * @property {string} scopeName - The unique name of the Scope
83
+ * @property {string} collectionName - The unique name of the Collection
84
+ * @property {string} docId - The unique id of the document
85
+ */
86
+ export interface CollectionDeleteDocumentArgs extends CollectionArgs {
87
+ docId: string;
88
+ concurrencyControl: ConcurrencyControl;
89
+ }
90
+ /**
91
+ * Represents arguments for a deleting an Index
92
+ *
93
+ * This interface is used to return the arguments
94
+ * for deleting an Index in a Collection
95
+ *
96
+ * @interface
97
+ * @property {string} name - The unique name of the database
98
+ * @property {string} scopeName - The unique name of the Scope
99
+ * @property {string} collectionName - The unique name of the Collection
100
+ * @property {string} existsName - The unique name of the database
101
+ * @property {string} directory - The full path to the database on the device
102
+ */
103
+ export interface CollectionDeleteIndexArgs extends CollectionArgs {
104
+ indexName: string;
105
+ }
106
+ export interface CollectionDocumentGetBlobContentArgs extends CollectionArgs {
107
+ documentId: string;
108
+ key: string;
109
+ }
110
+ export interface CollectionDocumentExpirationArgs extends CollectionArgs {
111
+ docId: string;
112
+ expiration: Date;
113
+ }
114
+ export interface CollectionDocumentSaveResult {
115
+ _id: string;
116
+ _revId: string;
117
+ _sequence: number;
118
+ }
119
+ /**
120
+ * Represents arguments for a getting a document from a collection
121
+ *
122
+ * This interface is used to return the arguments
123
+ * for gettig a document from a Collection
124
+ *
125
+ * @interface
126
+ * @property {string} name - The unique name of the database
127
+ * @property {string} scopeName - The unique name of the Scope
128
+ * @property {string} collectionName - The unique name of the Collection
129
+ * @property {string} docId - The unique id of the document
130
+ */
131
+ export interface CollectionGetDocumentArgs extends CollectionArgs {
132
+ docId: string;
133
+ }
134
+ /**
135
+ * Represents arguments for a purging a document from a collection
136
+ *
137
+ * This interface is used to return the arguments
138
+ * for purging a document from a Collection
139
+ *
140
+ * @interface
141
+ * @property {string} name - The unique name of the database
142
+ * @property {string} scopeName - The unique name of the Scope
143
+ * @property {string} collectionName - The unique name of the Collection
144
+ * @property {string} docId - The unique id of the document
145
+ */
146
+ export interface CollectionPurgeDocumentArgs extends CollectionArgs {
147
+ docId: string;
148
+ }
149
+ export interface CollectionSaveArgs extends CollectionArgs {
150
+ id: string;
151
+ document: Dictionary;
152
+ concurrencyControl: ConcurrencyControl | null;
153
+ }
154
+ export interface CollectionSaveStringArgs extends CollectionArgs {
155
+ id: string;
156
+ document: string;
157
+ blobs: string;
158
+ concurrencyControl: ConcurrencyControl | null;
159
+ }
160
+ export interface CollectionsResult {
161
+ collections: Collection[];
162
+ }
163
+ /**
164
+ * Represents a Database argument
165
+ *
166
+ * This interface is used to return the arguments
167
+ * for getting a database
168
+ *
169
+ * @interface
170
+ * @property {string} name - The unique name of the database
171
+ */
172
+ export interface DatabaseArgs {
173
+ name: string;
174
+ }
175
+ /**
176
+ * Represents arguments for copying a Database
177
+ *
178
+ * This interface is used to return the arguments
179
+ * for copying a Database
180
+ *
181
+ * @interface
182
+ * @property {string} name - The unique name of the database
183
+ */
184
+ export interface DatabaseCopyArgs extends DatabaseArgs {
185
+ path: string;
186
+ newName: string;
187
+ config: DatabaseConfiguration;
188
+ }
189
+ /**
190
+ * @deprecated This interface will be removed in future versions. Use CollectionCreateIndexArgs instead.
191
+ */
192
+ export interface DatabaseCreateIndexArgs extends DatabaseArgs {
193
+ indexName: string;
194
+ index: AbstractIndex;
195
+ }
196
+ /**
197
+ * @deprecated This interface will be removed in future versions. Use CollectionDeleteDocumentArgs instead.
198
+ */
199
+ export interface DatabaseDeleteDocumentArgs extends DatabaseArgs {
200
+ docId: string;
201
+ concurrencyControl: ConcurrencyControl;
202
+ }
203
+ /**
204
+ * @deprecated This interface will be removed in future versions. Use CollectionDeleteIndexArgs instead.
205
+ */
206
+ export interface DatabaseDeleteIndexArgs extends DatabaseArgs {
207
+ indexName: string;
208
+ }
209
+ /**
210
+ * Represents arguments for a Database
211
+ *
212
+ * This interface is used to return the arguments
213
+ * for checking if a Database exists
214
+ *
215
+ * @interface
216
+ * @property {string} existsName - The unique name of the database
217
+ * @property {string} directory - The full path to the database on the device
218
+ */
219
+ export interface DatabaseExistsArgs {
220
+ databaseName: string;
221
+ directory: string;
222
+ }
223
+ /**
224
+ * Represents arguments for changing the encryption key of a Database
225
+ *
226
+ *
227
+ * @interface
228
+ * @property {string} name - The unique name of the database
229
+ * @property {string} newKey - the new encryption key - if null will remove the key
230
+ */
231
+ export interface DatabaseEncryptionKeyArgs extends DatabaseArgs {
232
+ newKey: string | null;
233
+ }
234
+ /**
235
+ * @deprecated This interface will be removed in future versions. Use CollectionDeleteDocumentArgs instead.
236
+ */
237
+ export interface DatabaseGetDocumentArgs extends DatabaseArgs {
238
+ docId: string;
239
+ }
240
+ /**
241
+ * Represents arguments for Opening a Database
242
+ *
243
+ * This interface is used to return the arguments
244
+ * for opening a Database
245
+ *
246
+ * @interface
247
+ * @property {string} name - The unique name of the database
248
+ */
249
+ export interface DatabaseOpenArgs extends DatabaseArgs {
250
+ config: DatabaseConfiguration;
251
+ }
252
+ /**
253
+ * Represents arguments for performing maintenance on a Database
254
+ *
255
+ * @interface
256
+ * @property {string} name - The unique name of the database
257
+ * @property {string} maintenanceType - The type of maintenance to perform
258
+ */
259
+ export interface DatabasePerformMaintenanceArgs extends DatabaseArgs {
260
+ maintenanceType: MaintenanceType;
261
+ }
262
+ /**
263
+ * @deprecated This interface will be removed in future versions. Use CollectionPurgeDocumentArgs instead.
264
+ */
265
+ export interface DatabasePurgeDocumentArgs extends DatabaseArgs {
266
+ docId: string;
267
+ }
268
+ /**
269
+ * @deprecated This interface will be removed in future versions. Use ColllectionSaveArgs instead.
270
+ */
271
+ export interface DatabaseSaveArgs extends DatabaseArgs {
272
+ id: string;
273
+ document: string;
274
+ blobs: string;
275
+ concurrencyControl: ConcurrencyControl | null;
276
+ }
277
+ export interface DatabaseSetFileLoggingConfigArgs extends DatabaseArgs {
278
+ config: DatabaseFileLoggingConfiguration;
279
+ }
280
+ export interface DatabaseSetLogLevelArgs {
281
+ domain: string;
282
+ logLevel: number;
283
+ }
284
+ /**
285
+ * Represents a change in a document in a given collection
286
+ *
287
+ * This interface is used to return single documentId that has changed
288
+ *
289
+ * @interface
290
+ * @property {string[]} documentId - The unique identifier of the document
291
+ * @property {Collection} collection - The collection the document is stored in
292
+ * @property {Database} database - The database the collection and document are stored in
293
+ */
294
+ export interface DocumentChange {
295
+ documentId: string;
296
+ collection: Collection;
297
+ database: Database;
298
+ }
299
+ export type DocumentChangeListener = (change: DocumentChange) => void;
300
+ /**
301
+ * Represents arguments in a change in a document in a collection.
302
+ *
303
+ * This interface is used set up a collection document change listener
304
+ *
305
+ * @interface
306
+ */
307
+ export interface DocumentChangeListenerArgs extends CollectionArgs {
308
+ documentId: string;
309
+ changeListenerToken: string;
310
+ }
311
+ /**
312
+ * @deprecated This interface will be removed in future versions. Use CollectionDocumentGetBlobContentArgs instead.
313
+ */
314
+ export interface DocumentGetBlobContentArgs extends DatabaseArgs {
315
+ documentId: string;
316
+ key: string;
317
+ }
318
+ export interface DocumentResult {
319
+ document: Document;
320
+ }
321
+ export interface DocumentExpirationResult {
322
+ date: Date;
323
+ }
324
+ /**
325
+ * Represents the interface for a listener callback
326
+ *
327
+ * @interface
328
+ */
329
+ export type ListenerCallback = (data: CallbackResultData, error?: CallbackResultError) => void;
330
+ /**
331
+ * Represents the interface for a listener handler that allows you to remove the listener
332
+ *
333
+ * @interface
334
+ */
335
+ export interface ListenerHandle {
336
+ remove: () => Promise<void>;
337
+ }
338
+ /**
339
+ * Represents a change in a collection.
340
+ *
341
+ * This interface is used to return a set of documents
342
+ * that have changed from a change listener
343
+ *
344
+ * @interface
345
+ * @property {string[]} documentIds - The unique identifier for each document
346
+ */
347
+ export interface QueryChange {
348
+ error: string;
349
+ query: Query;
350
+ results: ResultSet;
351
+ }
352
+ export type QueryChangeListener = (change: QueryChange) => void;
353
+ /**
354
+ * Represents arguments in a change in a document in a collection.
355
+ *
356
+ * This interface is used set up a collection document change listener
357
+ *
358
+ * @interface
359
+ */
360
+ export interface QueryChangeListenerArgs extends QueryExecuteArgs {
361
+ changeListenerToken: string;
362
+ }
363
+ /**
364
+ * Represents arguments in a change in a collection.
365
+ *
366
+ * This interface is used set up a collection change listener
367
+ *
368
+ * @interface
369
+ */
370
+ export interface QueryRemoveChangeListenerArgs extends DatabaseArgs {
371
+ changeListenerToken: string;
372
+ }
373
+ export interface QueryExecuteArgs extends DatabaseArgs {
374
+ query: string;
375
+ parameters: Dictionary;
376
+ }
377
+ export interface ReplicatorArgs {
378
+ replicatorId: string;
379
+ }
380
+ export interface ReplicatorCollectionArgs extends ReplicatorArgs, CollectionArgs {
381
+ }
382
+ export type ReplicatorChangeListener = (change: ReplicatorStatusChange) => void;
383
+ export type ReplicatorDocumentChangeListener = (change: DocumentReplicationRepresentation) => void;
384
+ export interface ReplicatorCreateArgs {
385
+ config: any;
386
+ }
387
+ /**
388
+ * Represents arguments in a change in a collection.
389
+ *
390
+ * This interface is used set up a collection change listener
391
+ *
392
+ * @interface
393
+ */
394
+ export interface ReplicationChangeListenerArgs extends ReplicatorArgs {
395
+ changeListenerToken: string;
396
+ }
397
+ export interface ReplicatorDocumentPendingArgs extends ReplicatorArgs, CollectionArgs {
398
+ documentId: string;
399
+ }
400
+ export interface ReplicatorStatusChange {
401
+ status: ReplicatorStatus;
402
+ }
403
+ /**
404
+ * Represents a Scope argument
405
+ *
406
+ * This interface is used to return the arguments
407
+ * for getting a Scope from a Database
408
+ *
409
+ * @interface
410
+ * @property {string} name - The unique name of the database
411
+ * @property {string} scopeName - The unique name of the Scope
412
+ */
413
+ export interface ScopeArgs {
414
+ name: string;
415
+ scopeName: string;
416
+ }
417
+ export interface ScopesResult {
418
+ scopes: Scope[];
419
+ }
420
+ /**
421
+ * Represents engine for the core functionality of the Couchbase Lite Plugin
422
+ *
423
+ * @interface
424
+ */
425
+ export interface ICoreEngine {
426
+ collection_AddChangeListener(args: CollectionChangeListenerArgs, lcb: ListenerCallback): Promise<void>;
427
+ collection_AddDocumentChangeListener(args: DocumentChangeListenerArgs, lcb: ListenerCallback): Promise<void>;
428
+ collection_CreateCollection(args: CollectionArgs): Promise<Collection>;
429
+ /**
430
+ * Represents creating an Index
431
+ *
432
+ * This function is used to for creating an Index in a Collection
433
+ *
434
+ * @interface
435
+ * @property {CollectionCreateIndexArgs} arguments for creating an Index
436
+ */
437
+ collection_CreateIndex(args: CollectionCreateIndexArgs): Promise<void>;
438
+ collection_DeleteCollection(args: CollectionArgs): Promise<void>;
439
+ /**
440
+ * Delete a document from the collection. The default concurrency control, lastWriteWins,
441
+ * will be used when there is conflict during delete. If the document doesn’t exist in the
442
+ * collection, an error will be thrown.
443
+ *
444
+ * When deleting a document that already belongs to a collection, the collection instance of
445
+ * the document and this collection instance must be the same, otherwise, an
446
+ * error will be thrown.
447
+ *
448
+ * Throws an Error if the collection is deleted or the database is closed.
449
+ *
450
+ * @function
451
+ */
452
+ collection_DeleteDocument(args: CollectionDeleteDocumentArgs): Promise<void>;
453
+ /**
454
+ * Represents deleting an Index
455
+ *
456
+ * This function is used to for deleting an Index in a Collection
457
+ *
458
+ * @interface
459
+ * @property {CollectionDeleteIndexArgs} arguments for deleting an Index
460
+ */
461
+ collection_DeleteIndex(args: CollectionDeleteIndexArgs): Promise<void>;
462
+ collection_GetCollection(args: CollectionArgs): Promise<Collection>;
463
+ collection_GetCollections(args: ScopeArgs): Promise<CollectionsResult>;
464
+ /**
465
+ * Total number of documents in the collection.
466
+ *
467
+ * @function
468
+ */
469
+ collection_GetCount(args: CollectionArgs): Promise<{
470
+ count: number;
471
+ }>;
472
+ collection_GetDefault(args: DatabaseArgs): Promise<Collection>;
473
+ /**
474
+ * Get an existing document by document ID.
475
+ *
476
+ * Throws an error if the collection is deleted or the database is closed.
477
+ *
478
+ * @function
479
+ */
480
+ collection_GetDocument(args: CollectionGetDocumentArgs): Promise<DocumentResult>;
481
+ /**
482
+ * Get an existing document exipiration date by document ID.
483
+ *
484
+ * Throws an error if the collection is deleted or the database is closed.
485
+ *
486
+ * @function
487
+ */
488
+ collection_GetDocumentExpiration(args: CollectionGetDocumentArgs): Promise<DocumentExpirationResult>;
489
+ collection_GetBlobContent(args: CollectionDocumentGetBlobContentArgs): Promise<{
490
+ data: ArrayBuffer;
491
+ }>;
492
+ /**
493
+ * Represents getting an Index
494
+ *
495
+ * This function is used to for getting an Index in a Collection
496
+ *
497
+ * @interface
498
+ * @property {CollectionArgs} arguments for getting an Index
499
+ */
500
+ collection_GetIndexes(args: CollectionArgs): Promise<{
501
+ indexes: string[];
502
+ }>;
503
+ /**
504
+ * Purge a document by id from the collection. If the document doesn’t exist in the
505
+ * collection, an error will be thrown.
506
+ *
507
+ * Throws an error if the collection is deleted or the database is closed.
508
+ *
509
+ * @function
510
+ */
511
+ collection_PurgeDocument(args: CollectionPurgeDocumentArgs): Promise<void>;
512
+ collection_RemoveChangeListener(args: CollectionChangeListenerArgs): Promise<void>;
513
+ collection_RemoveDocumentChangeListener(args: CollectionChangeListenerArgs): Promise<void>;
514
+ /**
515
+ * Save a document into the collection. The default concurrency control, lastWriteWins, will
516
+ * be used when there is conflict during save.
517
+ *
518
+ * When saving a document that already belongs to a collection, the collection instance of
519
+ * the document and this collection instance must be the same, otherwise, an
520
+ * error will be thrown.
521
+ *
522
+ * Throws an error if the collection is deleted or the database is closed.
523
+ *
524
+ * @function
525
+ */
526
+ collection_Save(args: CollectionSaveStringArgs): Promise<CollectionDocumentSaveResult>;
527
+ /**
528
+ * Set an existing document expiration date by document ID.
529
+ *
530
+ * Throws an error if the collection is deleted or the database is closed.
531
+ *
532
+ * @function
533
+ */
534
+ collection_SetDocumentExpiration(args: CollectionDocumentExpirationArgs): Promise<void>;
535
+ database_ChangeEncryptionKey(args: DatabaseEncryptionKeyArgs): Promise<void>;
536
+ database_Close(args: DatabaseArgs): Promise<void>;
537
+ database_Copy(args: DatabaseCopyArgs): Promise<void>;
538
+ /**
539
+ * @deprecated This will be removed in future versions. Use collection_CreateIndex instead.
540
+ */
541
+ database_CreateIndex(args: DatabaseCreateIndexArgs): Promise<void>;
542
+ database_Delete(args: DatabaseArgs): Promise<void>;
543
+ database_DeleteWithPath(args: DatabaseExistsArgs): Promise<void>;
544
+ /**
545
+ * @deprecated This will be removed in future versions. Use Collection_DeleteDocument instead.
546
+ */
547
+ database_DeleteDocument(args: DatabaseDeleteDocumentArgs): Promise<void>;
548
+ /**
549
+ * @deprecated This will be removed in future versions. Use collection_DeleteIndex instead.
550
+ */
551
+ database_DeleteIndex(args: DatabaseDeleteIndexArgs): Promise<void>;
552
+ database_Exists(args: DatabaseExistsArgs): Promise<{
553
+ exists: boolean;
554
+ }>;
555
+ /**
556
+ * @deprecated This will be removed in future versions. Use collection_GetCount instead.
557
+ */
558
+ database_GetCount(args: DatabaseArgs): Promise<{
559
+ count: number;
560
+ }>;
561
+ /**
562
+ * @deprecated This will be removed in future versions. Use Collection_GetDocument instead.
563
+ */
564
+ database_GetDocument(args: DatabaseGetDocumentArgs): Promise<DocumentResult>;
565
+ /**
566
+ * @deprecated This will be removed in future versions. Use collection_GetIndexes instead.
567
+ */
568
+ database_GetIndexes(args: DatabaseArgs): Promise<{
569
+ indexes: string[];
570
+ }>;
571
+ database_GetPath(args: DatabaseArgs): Promise<{
572
+ path: string;
573
+ }>;
574
+ database_Open(args: DatabaseOpenArgs): Promise<void>;
575
+ database_PerformMaintenance(args: DatabasePerformMaintenanceArgs): Promise<void>;
576
+ /**
577
+ * @deprecated This will be removed in future versions. Use collection_PurgeDocument instead.
578
+ */
579
+ database_PurgeDocument(args: DatabasePurgeDocumentArgs): Promise<void>;
580
+ /**
581
+ * @deprecated This will be removed in future versions. Use collection_Save instead.
582
+ */
583
+ database_Save(args: DatabaseSaveArgs): Promise<{
584
+ _id: string;
585
+ }>;
586
+ database_SetFileLoggingConfig(args: DatabaseSetFileLoggingConfigArgs): Promise<void>;
587
+ database_SetLogLevel(args: DatabaseSetLogLevelArgs): Promise<void>;
588
+ /**
589
+ * @deprecated This will be removed in future versions. Use Collection_GetDocumentBlobContent instead.
590
+ */
591
+ document_GetBlobContent(args: DocumentGetBlobContentArgs): Promise<{
592
+ data: ArrayBuffer;
593
+ }>;
594
+ /**
595
+ * Represents getting a default path from the operating system to save a database
596
+ *
597
+ * This function is used to for returning the default path on the operating system to save a database
598
+ *
599
+ * @function
600
+ */
601
+ file_GetDefaultPath(): Promise<{
602
+ path: string;
603
+ }>;
604
+ file_GetFileNamesInDirectory(args: {
605
+ path: string;
606
+ }): Promise<{
607
+ files: string[];
608
+ }>;
609
+ query_AddChangeListener(args: QueryChangeListenerArgs, lcb: ListenerCallback): Promise<void>;
610
+ query_Execute(args: QueryExecuteArgs): Promise<Result>;
611
+ query_Explain(args: QueryExecuteArgs): Promise<{
612
+ data: string;
613
+ }>;
614
+ query_RemoveChangeListener(args: QueryRemoveChangeListenerArgs): Promise<void>;
615
+ replicator_AddChangeListener(args: ReplicationChangeListenerArgs, lcb: ListenerCallback): Promise<void>;
616
+ replicator_AddDocumentChangeListener(args: ReplicationChangeListenerArgs, lcb: ListenerCallback): Promise<void>;
617
+ replicator_Cleanup(args: ReplicatorArgs): Promise<void>;
618
+ replicator_Create(args: any): Promise<ReplicatorArgs>;
619
+ replicator_GetStatus(args: ReplicatorArgs): Promise<ReplicatorStatus>;
620
+ replicator_GetPendingDocumentIds(args: ReplicatorCollectionArgs): Promise<{
621
+ pendingDocumentIds: string[];
622
+ }>;
623
+ replicator_IsDocumentPending(args: ReplicatorDocumentPendingArgs): Promise<{
624
+ isPending: boolean;
625
+ }>;
626
+ replicator_Start(args: ReplicatorArgs): Promise<void>;
627
+ replicator_Stop(args: ReplicatorArgs): Promise<void>;
628
+ replicator_RemoveChangeListener(args: ReplicationChangeListenerArgs): Promise<void>;
629
+ replicator_ResetCheckpoint(args: ReplicatorArgs): Promise<void>;
630
+ scope_GetDefault(args: DatabaseArgs): Promise<Scope>;
631
+ scope_GetScope(args: ScopeArgs): Promise<Scope>;
632
+ scope_GetScopes(args: DatabaseArgs): Promise<ScopesResult>;
633
+ getUUID(): string;
634
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=core-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"core-types.js","sourceRoot":"","sources":["../../../../src/cblite-js/cblite/core-types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from './core-types';
2
+ export * from './src/index';
@@ -0,0 +1,4 @@
1
+ //export the framework
2
+ export * from './core-types';
3
+ export * from './src/index';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/cblite-js/cblite/index.ts"],"names":[],"mappings":"AAAA,sBAAsB;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"}
@@ -0,0 +1,14 @@
1
+ export interface Index {
2
+ }
3
+ export declare enum IndexType {
4
+ Value = 0,
5
+ FullText = 1,
6
+ Geo = 2
7
+ }
8
+ export declare abstract class AbstractIndex implements Index {
9
+ abstract type(): IndexType;
10
+ abstract language(): string;
11
+ abstract ignoreAccents(): boolean;
12
+ abstract items(): any[];
13
+ abstract toJson(): any;
14
+ }
@@ -0,0 +1,12 @@
1
+ export var IndexType;
2
+ (function (IndexType) {
3
+ // eslint-disable-next-line
4
+ IndexType[IndexType["Value"] = 0] = "Value";
5
+ // eslint-disable-next-line
6
+ IndexType[IndexType["FullText"] = 1] = "FullText";
7
+ // eslint-disable-next-line
8
+ IndexType[IndexType["Geo"] = 2] = "Geo";
9
+ })(IndexType || (IndexType = {}));
10
+ export class AbstractIndex {
11
+ }
12
+ //# sourceMappingURL=abstract-index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"abstract-index.js","sourceRoot":"","sources":["../../../../../src/cblite-js/cblite/src/abstract-index.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,2BAA2B;IAC3B,2CAAS,CAAA;IACT,2BAA2B;IAC3B,iDAAY,CAAA;IACZ,2BAA2B;IAC3B,uCAAO,CAAA;AACT,CAAC,EAPW,SAAS,KAAT,SAAS,QAOpB;AAED,MAAM,OAAgB,aAAa;CAWlC"}
@@ -0,0 +1,6 @@
1
+ import { Dictionary } from './definitions';
2
+ export declare abstract class Authenticator {
3
+ abstract authenticate(options: Dictionary): void;
4
+ abstract getType(): string;
5
+ abstract toJson(): any;
6
+ }
@@ -0,0 +1,3 @@
1
+ export class Authenticator {
2
+ }
3
+ //# sourceMappingURL=authenticator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"authenticator.js","sourceRoot":"","sources":["../../../../../src/cblite-js/cblite/src/authenticator.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,aAAa;CAKlC"}