node-appwrite 12.0.1 → 12.1.0-rc.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 (298) hide show
  1. package/.travis.yml +18 -8
  2. package/README.md +1 -1
  3. package/dist/client.d.mts +131 -0
  4. package/dist/client.d.ts +131 -0
  5. package/dist/client.js +302 -0
  6. package/dist/client.js.map +1 -0
  7. package/dist/client.mjs +295 -0
  8. package/dist/client.mjs.map +1 -0
  9. package/dist/enums/authentication-factor.d.mts +8 -0
  10. package/dist/enums/authentication-factor.d.ts +8 -0
  11. package/dist/enums/authentication-factor.js +13 -0
  12. package/dist/enums/authentication-factor.js.map +1 -0
  13. package/dist/enums/authentication-factor.mjs +11 -0
  14. package/dist/enums/authentication-factor.mjs.map +1 -0
  15. package/dist/enums/authenticator-type.d.mts +5 -0
  16. package/dist/enums/authenticator-type.d.ts +5 -0
  17. package/dist/enums/authenticator-type.js +10 -0
  18. package/dist/enums/authenticator-type.js.map +1 -0
  19. package/dist/enums/authenticator-type.mjs +8 -0
  20. package/dist/enums/authenticator-type.mjs.map +1 -0
  21. package/dist/enums/browser.d.mts +18 -0
  22. package/dist/enums/browser.d.ts +18 -0
  23. package/dist/enums/browser.js +23 -0
  24. package/dist/enums/browser.js.map +1 -0
  25. package/dist/enums/browser.mjs +21 -0
  26. package/dist/enums/browser.mjs.map +1 -0
  27. package/dist/enums/compression.d.mts +7 -0
  28. package/dist/enums/compression.d.ts +7 -0
  29. package/dist/enums/compression.js +12 -0
  30. package/dist/enums/compression.js.map +1 -0
  31. package/dist/enums/compression.mjs +10 -0
  32. package/dist/enums/compression.mjs.map +1 -0
  33. package/dist/enums/credit-card.d.mts +20 -0
  34. package/dist/enums/credit-card.d.ts +20 -0
  35. package/dist/enums/credit-card.js +25 -0
  36. package/dist/enums/credit-card.js.map +1 -0
  37. package/dist/enums/credit-card.mjs +23 -0
  38. package/dist/enums/credit-card.mjs.map +1 -0
  39. package/dist/enums/execution-method.d.mts +10 -0
  40. package/dist/enums/execution-method.d.ts +10 -0
  41. package/dist/enums/execution-method.js +15 -0
  42. package/dist/enums/execution-method.js.map +1 -0
  43. package/dist/enums/execution-method.mjs +13 -0
  44. package/dist/enums/execution-method.mjs.map +1 -0
  45. package/dist/enums/flag.d.mts +198 -0
  46. package/dist/enums/flag.d.ts +198 -0
  47. package/dist/enums/flag.js +203 -0
  48. package/dist/enums/flag.js.map +1 -0
  49. package/dist/enums/flag.mjs +201 -0
  50. package/dist/enums/flag.mjs.map +1 -0
  51. package/dist/enums/image-format.d.mts +9 -0
  52. package/dist/enums/image-format.d.ts +9 -0
  53. package/dist/enums/image-format.js +14 -0
  54. package/dist/enums/image-format.js.map +1 -0
  55. package/dist/enums/image-format.mjs +12 -0
  56. package/dist/enums/image-format.mjs.map +1 -0
  57. package/dist/enums/image-gravity.d.mts +13 -0
  58. package/dist/enums/image-gravity.d.ts +13 -0
  59. package/dist/enums/image-gravity.js +18 -0
  60. package/dist/enums/image-gravity.js.map +1 -0
  61. package/dist/enums/image-gravity.mjs +16 -0
  62. package/dist/enums/image-gravity.mjs.map +1 -0
  63. package/dist/enums/index-type.d.mts +7 -0
  64. package/dist/enums/index-type.d.ts +7 -0
  65. package/dist/enums/index-type.js +12 -0
  66. package/dist/enums/index-type.js.map +1 -0
  67. package/dist/enums/index-type.mjs +10 -0
  68. package/dist/enums/index-type.mjs.map +1 -0
  69. package/dist/enums/messaging-provider-type.d.mts +7 -0
  70. package/dist/enums/messaging-provider-type.d.ts +7 -0
  71. package/dist/enums/messaging-provider-type.js +12 -0
  72. package/dist/enums/messaging-provider-type.js.map +1 -0
  73. package/dist/enums/messaging-provider-type.mjs +10 -0
  74. package/dist/enums/messaging-provider-type.mjs.map +1 -0
  75. package/dist/enums/name.d.mts +17 -0
  76. package/dist/enums/name.d.ts +17 -0
  77. package/dist/enums/name.js +22 -0
  78. package/dist/enums/name.js.map +1 -0
  79. package/dist/enums/name.mjs +20 -0
  80. package/dist/enums/name.mjs.map +1 -0
  81. package/dist/enums/o-auth-provider.d.mts +43 -0
  82. package/dist/enums/o-auth-provider.d.ts +43 -0
  83. package/dist/enums/o-auth-provider.js +48 -0
  84. package/dist/enums/o-auth-provider.js.map +1 -0
  85. package/dist/enums/o-auth-provider.mjs +46 -0
  86. package/dist/enums/o-auth-provider.mjs.map +1 -0
  87. package/dist/enums/password-hash.d.mts +15 -0
  88. package/dist/enums/password-hash.d.ts +15 -0
  89. package/dist/enums/password-hash.js +20 -0
  90. package/dist/enums/password-hash.js.map +1 -0
  91. package/dist/enums/password-hash.mjs +18 -0
  92. package/dist/enums/password-hash.mjs.map +1 -0
  93. package/dist/enums/relation-mutate.d.mts +7 -0
  94. package/dist/enums/relation-mutate.d.ts +7 -0
  95. package/dist/enums/relation-mutate.js +12 -0
  96. package/dist/enums/relation-mutate.js.map +1 -0
  97. package/dist/enums/relation-mutate.mjs +10 -0
  98. package/dist/enums/relation-mutate.mjs.map +1 -0
  99. package/dist/enums/relationship-type.d.mts +8 -0
  100. package/dist/enums/relationship-type.d.ts +8 -0
  101. package/dist/enums/relationship-type.js +13 -0
  102. package/dist/enums/relationship-type.js.map +1 -0
  103. package/dist/enums/relationship-type.mjs +11 -0
  104. package/dist/enums/relationship-type.mjs.map +1 -0
  105. package/dist/enums/runtime.d.mts +48 -0
  106. package/dist/enums/runtime.d.ts +48 -0
  107. package/dist/enums/runtime.js +53 -0
  108. package/dist/enums/runtime.js.map +1 -0
  109. package/dist/enums/runtime.mjs +51 -0
  110. package/dist/enums/runtime.mjs.map +1 -0
  111. package/dist/enums/smtp-encryption.d.mts +7 -0
  112. package/dist/enums/smtp-encryption.d.ts +7 -0
  113. package/dist/enums/smtp-encryption.js +12 -0
  114. package/dist/enums/smtp-encryption.js.map +1 -0
  115. package/dist/enums/smtp-encryption.mjs +10 -0
  116. package/dist/enums/smtp-encryption.mjs.map +1 -0
  117. package/dist/id.d.mts +7 -0
  118. package/dist/id.d.ts +7 -0
  119. package/dist/id.js +29 -0
  120. package/dist/id.js.map +1 -0
  121. package/dist/id.mjs +27 -0
  122. package/dist/id.mjs.map +1 -0
  123. package/dist/index.d.mts +35 -0
  124. package/dist/index.d.ts +35 -0
  125. package/dist/index.js +180 -0
  126. package/dist/index.js.map +1 -0
  127. package/dist/index.mjs +35 -0
  128. package/dist/index.mjs.map +1 -0
  129. package/dist/inputFile.d.mts +9 -0
  130. package/dist/inputFile.d.ts +9 -0
  131. package/dist/inputFile.js +23 -0
  132. package/dist/inputFile.js.map +1 -0
  133. package/dist/inputFile.mjs +21 -0
  134. package/dist/inputFile.mjs.map +1 -0
  135. package/dist/models.d.mts +2406 -0
  136. package/dist/models.d.ts +2406 -0
  137. package/dist/models.js +4 -0
  138. package/dist/models.js.map +1 -0
  139. package/dist/models.mjs +3 -0
  140. package/dist/models.mjs.map +1 -0
  141. package/dist/permission.d.mts +9 -0
  142. package/dist/permission.d.ts +9 -0
  143. package/dist/permission.js +23 -0
  144. package/dist/permission.js.map +1 -0
  145. package/dist/permission.mjs +21 -0
  146. package/dist/permission.mjs.map +1 -0
  147. package/dist/query.d.mts +35 -0
  148. package/dist/query.d.ts +35 -0
  149. package/dist/query.js +49 -0
  150. package/dist/query.js.map +1 -0
  151. package/dist/query.mjs +47 -0
  152. package/dist/query.mjs.map +1 -0
  153. package/dist/role.d.mts +72 -0
  154. package/dist/role.d.ts +72 -0
  155. package/dist/role.js +96 -0
  156. package/dist/role.js.map +1 -0
  157. package/dist/role.mjs +94 -0
  158. package/dist/role.mjs.map +1 -0
  159. package/dist/services/account.d.mts +478 -0
  160. package/dist/services/account.d.ts +478 -0
  161. package/dist/services/account.js +1331 -0
  162. package/dist/services/account.js.map +1 -0
  163. package/dist/services/account.mjs +1329 -0
  164. package/dist/services/account.mjs.map +1 -0
  165. package/dist/services/avatars.d.mts +118 -0
  166. package/dist/services/avatars.d.ts +118 -0
  167. package/dist/services/avatars.js +297 -0
  168. package/dist/services/avatars.js.map +1 -0
  169. package/dist/services/avatars.mjs +295 -0
  170. package/dist/services/avatars.mjs.map +1 -0
  171. package/dist/services/databases.d.mts +606 -0
  172. package/dist/services/databases.d.ts +606 -0
  173. package/dist/services/databases.js +1908 -0
  174. package/dist/services/databases.js.map +1 -0
  175. package/dist/services/databases.mjs +1906 -0
  176. package/dist/services/databases.mjs.map +1 -0
  177. package/dist/services/functions.d.mts +287 -0
  178. package/dist/services/functions.d.ts +287 -0
  179. package/dist/services/functions.js +837 -0
  180. package/dist/services/functions.js.map +1 -0
  181. package/dist/services/functions.mjs +835 -0
  182. package/dist/services/functions.mjs.map +1 -0
  183. package/dist/services/graphql.d.mts +30 -0
  184. package/dist/services/graphql.d.ts +30 -0
  185. package/dist/services/graphql.js +73 -0
  186. package/dist/services/graphql.js.map +1 -0
  187. package/dist/services/graphql.mjs +71 -0
  188. package/dist/services/graphql.mjs.map +1 -0
  189. package/dist/services/health.d.mts +235 -0
  190. package/dist/services/health.d.ts +235 -0
  191. package/dist/services/health.js +584 -0
  192. package/dist/services/health.js.map +1 -0
  193. package/dist/services/health.mjs +582 -0
  194. package/dist/services/health.mjs.map +1 -0
  195. package/dist/services/locale.d.mts +84 -0
  196. package/dist/services/locale.d.ts +84 -0
  197. package/dist/services/locale.js +189 -0
  198. package/dist/services/locale.js.map +1 -0
  199. package/dist/services/locale.mjs +187 -0
  200. package/dist/services/locale.mjs.map +1 -0
  201. package/dist/services/messaging.d.mts +688 -0
  202. package/dist/services/messaging.d.ts +688 -0
  203. package/dist/services/messaging.js +2152 -0
  204. package/dist/services/messaging.js.map +1 -0
  205. package/dist/services/messaging.mjs +2150 -0
  206. package/dist/services/messaging.mjs.map +1 -0
  207. package/dist/services/storage.d.mts +193 -0
  208. package/dist/services/storage.d.ts +193 -0
  209. package/dist/services/storage.js +550 -0
  210. package/dist/services/storage.js.map +1 -0
  211. package/dist/services/storage.mjs +548 -0
  212. package/dist/services/storage.mjs.map +1 -0
  213. package/dist/services/teams.d.mts +171 -0
  214. package/dist/services/teams.d.ts +171 -0
  215. package/dist/services/teams.js +466 -0
  216. package/dist/services/teams.js.map +1 -0
  217. package/dist/services/teams.mjs +464 -0
  218. package/dist/services/teams.mjs.map +1 -0
  219. package/dist/services/users.d.mts +490 -0
  220. package/dist/services/users.d.ts +490 -0
  221. package/dist/services/users.js +1464 -0
  222. package/dist/services/users.js.map +1 -0
  223. package/dist/services/users.mjs +1462 -0
  224. package/dist/services/users.mjs.map +1 -0
  225. package/docs/examples/functions/create-deployment.md +1 -1
  226. package/docs/examples/messaging/create-msg91provider.md +1 -1
  227. package/docs/examples/messaging/update-msg91provider.md +2 -2
  228. package/docs/examples/storage/create-file.md +1 -1
  229. package/package.json +35 -5
  230. package/src/client.ts +366 -0
  231. package/src/enums/authentication-factor.ts +6 -0
  232. package/src/enums/authenticator-type.ts +3 -0
  233. package/src/enums/browser.ts +16 -0
  234. package/src/enums/compression.ts +5 -0
  235. package/src/enums/credit-card.ts +18 -0
  236. package/src/enums/execution-method.ts +8 -0
  237. package/src/enums/flag.ts +196 -0
  238. package/src/enums/image-format.ts +7 -0
  239. package/src/enums/image-gravity.ts +11 -0
  240. package/src/enums/index-type.ts +5 -0
  241. package/src/enums/messaging-provider-type.ts +5 -0
  242. package/src/enums/name.ts +15 -0
  243. package/src/enums/o-auth-provider.ts +41 -0
  244. package/src/enums/password-hash.ts +13 -0
  245. package/src/enums/relation-mutate.ts +5 -0
  246. package/src/enums/relationship-type.ts +6 -0
  247. package/src/enums/runtime.ts +46 -0
  248. package/src/enums/smtp-encryption.ts +5 -0
  249. package/{lib/id.js → src/id.ts} +8 -12
  250. package/src/index.ts +35 -0
  251. package/src/inputFile.ts +23 -0
  252. package/src/models.ts +2404 -0
  253. package/src/permission.ts +22 -0
  254. package/src/query.ts +101 -0
  255. package/{lib/role.js → src/role.ts} +23 -25
  256. package/src/services/account.ts +1418 -0
  257. package/src/services/avatars.ts +312 -0
  258. package/{lib/services/databases.js → src/services/databases.ts} +644 -638
  259. package/{lib/services/functions.js → src/services/functions.ts} +317 -369
  260. package/{lib/services/graphql.js → src/services/graphql.ts} +35 -34
  261. package/src/services/health.ts +629 -0
  262. package/src/services/locale.ts +205 -0
  263. package/{lib/services/messaging.js → src/services/messaging.ts} +666 -641
  264. package/{lib/services/storage.js → src/services/storage.ts} +211 -298
  265. package/{lib/services/teams.js → src/services/teams.ts} +211 -200
  266. package/{lib/services/users.js → src/services/users.ts} +603 -519
  267. package/tsconfig.json +18 -0
  268. package/tsup.config.js +19 -0
  269. package/index.d.ts +0 -6656
  270. package/index.js +0 -75
  271. package/lib/client.js +0 -245
  272. package/lib/enums/authentication-factor.js +0 -8
  273. package/lib/enums/authenticator-type.js +0 -5
  274. package/lib/enums/browser.js +0 -18
  275. package/lib/enums/compression.js +0 -7
  276. package/lib/enums/credit-card.js +0 -20
  277. package/lib/enums/execution-method.js +0 -10
  278. package/lib/enums/flag.js +0 -198
  279. package/lib/enums/image-format.js +0 -9
  280. package/lib/enums/image-gravity.js +0 -13
  281. package/lib/enums/index-type.js +0 -7
  282. package/lib/enums/messaging-provider-type.js +0 -7
  283. package/lib/enums/name.js +0 -17
  284. package/lib/enums/o-auth-provider.js +0 -43
  285. package/lib/enums/password-hash.js +0 -15
  286. package/lib/enums/relation-mutate.js +0 -7
  287. package/lib/enums/relationship-type.js +0 -8
  288. package/lib/enums/runtime.js +0 -48
  289. package/lib/enums/smtp-encryption.js +0 -7
  290. package/lib/exception.js +0 -10
  291. package/lib/inputFile.js +0 -117
  292. package/lib/permission.js +0 -24
  293. package/lib/query.js +0 -90
  294. package/lib/service.js +0 -10
  295. package/lib/services/account.js +0 -1365
  296. package/lib/services/avatars.js +0 -325
  297. package/lib/services/health.js +0 -513
  298. package/lib/services/locale.js +0 -169
package/dist/models.js ADDED
@@ -0,0 +1,4 @@
1
+ 'use strict';
2
+
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=models.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+
2
+ //# sourceMappingURL=out.js.map
3
+ //# sourceMappingURL=models.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ declare class Permission {
2
+ static read: (role: string) => string;
3
+ static write: (role: string) => string;
4
+ static create: (role: string) => string;
5
+ static update: (role: string) => string;
6
+ static delete: (role: string) => string;
7
+ }
8
+
9
+ export { Permission };
@@ -0,0 +1,9 @@
1
+ declare class Permission {
2
+ static read: (role: string) => string;
3
+ static write: (role: string) => string;
4
+ static create: (role: string) => string;
5
+ static update: (role: string) => string;
6
+ static delete: (role: string) => string;
7
+ }
8
+
9
+ export { Permission };
@@ -0,0 +1,23 @@
1
+ 'use strict';
2
+
3
+ class Permission {
4
+ }
5
+ Permission.read = (role) => {
6
+ return `read("${role}")`;
7
+ };
8
+ Permission.write = (role) => {
9
+ return `write("${role}")`;
10
+ };
11
+ Permission.create = (role) => {
12
+ return `create("${role}")`;
13
+ };
14
+ Permission.update = (role) => {
15
+ return `update("${role}")`;
16
+ };
17
+ Permission.delete = (role) => {
18
+ return `delete("${role}")`;
19
+ };
20
+
21
+ exports.Permission = Permission;
22
+ //# sourceMappingURL=out.js.map
23
+ //# sourceMappingURL=permission.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":"AAAO,MAAM,WAAW;AAqBxB;AArBa,WAEF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAJS,WAMF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AARS,WAUF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAZS,WAcF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAhBS,WAkBF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["export class Permission {\n\n static read = (role: string): string => {\n return `read(\"${role}\")`\n }\n\n static write = (role: string): string => {\n return `write(\"${role}\")`\n }\n\n static create = (role: string): string => {\n return `create(\"${role}\")`\n }\n\n static update = (role: string): string => {\n return `update(\"${role}\")`\n }\n\n static delete = (role: string): string => {\n return `delete(\"${role}\")`\n }\n}\n"]}
@@ -0,0 +1,21 @@
1
+ class Permission {
2
+ }
3
+ Permission.read = (role) => {
4
+ return `read("${role}")`;
5
+ };
6
+ Permission.write = (role) => {
7
+ return `write("${role}")`;
8
+ };
9
+ Permission.create = (role) => {
10
+ return `create("${role}")`;
11
+ };
12
+ Permission.update = (role) => {
13
+ return `update("${role}")`;
14
+ };
15
+ Permission.delete = (role) => {
16
+ return `delete("${role}")`;
17
+ };
18
+
19
+ export { Permission };
20
+ //# sourceMappingURL=out.js.map
21
+ //# sourceMappingURL=permission.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":"AAAO,MAAM,WAAW;AAqBxB;AArBa,WAEF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAJS,WAMF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AARS,WAUF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAZS,WAcF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAhBS,WAkBF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["export class Permission {\n\n static read = (role: string): string => {\n return `read(\"${role}\")`\n }\n\n static write = (role: string): string => {\n return `write(\"${role}\")`\n }\n\n static create = (role: string): string => {\n return `create(\"${role}\")`\n }\n\n static update = (role: string): string => {\n return `update(\"${role}\")`\n }\n\n static delete = (role: string): string => {\n return `delete(\"${role}\")`\n }\n}\n"]}
@@ -0,0 +1,35 @@
1
+ type QueryTypesSingle = string | number | boolean;
2
+ type QueryTypesList = string[] | number[] | boolean[] | Query[];
3
+ type QueryTypes = QueryTypesSingle | QueryTypesList;
4
+ type AttributesTypes = string | string[];
5
+ declare class Query {
6
+ method: string;
7
+ attribute: AttributesTypes | undefined;
8
+ values: QueryTypesList | undefined;
9
+ constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
10
+ toString(): string;
11
+ static equal: (attribute: string, value: QueryTypes) => string;
12
+ static notEqual: (attribute: string, value: QueryTypes) => string;
13
+ static lessThan: (attribute: string, value: QueryTypes) => string;
14
+ static lessThanEqual: (attribute: string, value: QueryTypes) => string;
15
+ static greaterThan: (attribute: string, value: QueryTypes) => string;
16
+ static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
17
+ static isNull: (attribute: string) => string;
18
+ static isNotNull: (attribute: string) => string;
19
+ static between: (attribute: string, start: string | number, end: string | number) => string;
20
+ static startsWith: (attribute: string, value: string) => string;
21
+ static endsWith: (attribute: string, value: string) => string;
22
+ static select: (attributes: string[]) => string;
23
+ static search: (attribute: string, value: string) => string;
24
+ static orderDesc: (attribute: string) => string;
25
+ static orderAsc: (attribute: string) => string;
26
+ static cursorAfter: (documentId: string) => string;
27
+ static cursorBefore: (documentId: string) => string;
28
+ static limit: (limit: number) => string;
29
+ static offset: (offset: number) => string;
30
+ static contains: (attribute: string, value: string | string[]) => string;
31
+ static or: (queries: string[]) => string;
32
+ static and: (queries: string[]) => string;
33
+ }
34
+
35
+ export { Query, QueryTypes, QueryTypesList };
@@ -0,0 +1,35 @@
1
+ type QueryTypesSingle = string | number | boolean;
2
+ type QueryTypesList = string[] | number[] | boolean[] | Query[];
3
+ type QueryTypes = QueryTypesSingle | QueryTypesList;
4
+ type AttributesTypes = string | string[];
5
+ declare class Query {
6
+ method: string;
7
+ attribute: AttributesTypes | undefined;
8
+ values: QueryTypesList | undefined;
9
+ constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
10
+ toString(): string;
11
+ static equal: (attribute: string, value: QueryTypes) => string;
12
+ static notEqual: (attribute: string, value: QueryTypes) => string;
13
+ static lessThan: (attribute: string, value: QueryTypes) => string;
14
+ static lessThanEqual: (attribute: string, value: QueryTypes) => string;
15
+ static greaterThan: (attribute: string, value: QueryTypes) => string;
16
+ static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
17
+ static isNull: (attribute: string) => string;
18
+ static isNotNull: (attribute: string) => string;
19
+ static between: (attribute: string, start: string | number, end: string | number) => string;
20
+ static startsWith: (attribute: string, value: string) => string;
21
+ static endsWith: (attribute: string, value: string) => string;
22
+ static select: (attributes: string[]) => string;
23
+ static search: (attribute: string, value: string) => string;
24
+ static orderDesc: (attribute: string) => string;
25
+ static orderAsc: (attribute: string) => string;
26
+ static cursorAfter: (documentId: string) => string;
27
+ static cursorBefore: (documentId: string) => string;
28
+ static limit: (limit: number) => string;
29
+ static offset: (offset: number) => string;
30
+ static contains: (attribute: string, value: string | string[]) => string;
31
+ static or: (queries: string[]) => string;
32
+ static and: (queries: string[]) => string;
33
+ }
34
+
35
+ export { Query, QueryTypes, QueryTypesList };
package/dist/query.js ADDED
@@ -0,0 +1,49 @@
1
+ 'use strict';
2
+
3
+ const _Query = class _Query {
4
+ constructor(method, attribute, values) {
5
+ this.method = method;
6
+ this.attribute = attribute;
7
+ if (values !== void 0) {
8
+ if (Array.isArray(values)) {
9
+ this.values = values;
10
+ } else {
11
+ this.values = [values];
12
+ }
13
+ }
14
+ }
15
+ toString() {
16
+ return JSON.stringify({
17
+ method: this.method,
18
+ attribute: this.attribute,
19
+ values: this.values
20
+ });
21
+ }
22
+ };
23
+ _Query.equal = (attribute, value) => new _Query("equal", attribute, value).toString();
24
+ _Query.notEqual = (attribute, value) => new _Query("notEqual", attribute, value).toString();
25
+ _Query.lessThan = (attribute, value) => new _Query("lessThan", attribute, value).toString();
26
+ _Query.lessThanEqual = (attribute, value) => new _Query("lessThanEqual", attribute, value).toString();
27
+ _Query.greaterThan = (attribute, value) => new _Query("greaterThan", attribute, value).toString();
28
+ _Query.greaterThanEqual = (attribute, value) => new _Query("greaterThanEqual", attribute, value).toString();
29
+ _Query.isNull = (attribute) => new _Query("isNull", attribute).toString();
30
+ _Query.isNotNull = (attribute) => new _Query("isNotNull", attribute).toString();
31
+ _Query.between = (attribute, start, end) => new _Query("between", attribute, [start, end]).toString();
32
+ _Query.startsWith = (attribute, value) => new _Query("startsWith", attribute, value).toString();
33
+ _Query.endsWith = (attribute, value) => new _Query("endsWith", attribute, value).toString();
34
+ _Query.select = (attributes) => new _Query("select", void 0, attributes).toString();
35
+ _Query.search = (attribute, value) => new _Query("search", attribute, value).toString();
36
+ _Query.orderDesc = (attribute) => new _Query("orderDesc", attribute).toString();
37
+ _Query.orderAsc = (attribute) => new _Query("orderAsc", attribute).toString();
38
+ _Query.cursorAfter = (documentId) => new _Query("cursorAfter", void 0, documentId).toString();
39
+ _Query.cursorBefore = (documentId) => new _Query("cursorBefore", void 0, documentId).toString();
40
+ _Query.limit = (limit) => new _Query("limit", void 0, limit).toString();
41
+ _Query.offset = (offset) => new _Query("offset", void 0, offset).toString();
42
+ _Query.contains = (attribute, value) => new _Query("contains", attribute, value).toString();
43
+ _Query.or = (queries) => new _Query("or", void 0, queries.map((query) => JSON.parse(query))).toString();
44
+ _Query.and = (queries) => new _Query("and", void 0, queries.map((query) => JSON.parse(query))).toString();
45
+ let Query = _Query;
46
+
47
+ exports.Query = Query;
48
+ //# sourceMappingURL=out.js.map
49
+ //# sourceMappingURL=query.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/query.ts"],"names":[],"mappings":"AAKO,MAAM,SAAN,MAAM,OAAM;AAAA,EAKjB,YACE,QACA,WACA,QACA;AACA,SAAK,SAAS;AACd,SAAK,YAAY;AAEjB,QAAI,WAAW,QAAW;AACxB,UAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,aAAK,SAAS;AAAA,MAChB,OAAO;AACL,aAAK,SAAS,CAAC,MAAM;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK,UAAU;AAAA,MACpB,QAAQ,KAAK;AAAA,MACb,WAAW,KAAK;AAAA,MAChB,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACH;AAmEF;AA/Fa,OA8BJ,QAAQ,CAAC,WAAmB,UACjC,IAAI,OAAM,SAAS,WAAW,KAAK,EAAE,SAAS;AA/BrC,OAiCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAlCxC,OAoCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AArCxC,OAuCJ,gBAAgB,CAAC,WAAmB,UACzC,IAAI,OAAM,iBAAiB,WAAW,KAAK,EAAE,SAAS;AAxC7C,OA0CJ,cAAc,CAAC,WAAmB,UACvC,IAAI,OAAM,eAAe,WAAW,KAAK,EAAE,SAAS;AA3C3C,OA6CJ,mBAAmB,CAAC,WAAmB,UAC5C,IAAI,OAAM,oBAAoB,WAAW,KAAK,EAAE,SAAS;AA9ChD,OAgDJ,SAAS,CAAC,cACf,IAAI,OAAM,UAAU,SAAS,EAAE,SAAS;AAjD/B,OAmDJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AApDlC,OAsDJ,UAAU,CAAC,WAAmB,OAAwB,QAC3D,IAAI,OAAM,WAAW,WAAW,CAAC,OAAO,GAAG,CAAmB,EAAE,SAAS;AAvDhE,OAyDJ,aAAa,CAAC,WAAmB,UACtC,IAAI,OAAM,cAAc,WAAW,KAAK,EAAE,SAAS;AA1D1C,OA4DJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AA7DxC,OA+DJ,SAAS,CAAC,eACf,IAAI,OAAM,UAAU,QAAW,UAAU,EAAE,SAAS;AAhE3C,OAkEJ,SAAS,CAAC,WAAmB,UAClC,IAAI,OAAM,UAAU,WAAW,KAAK,EAAE,SAAS;AAnEtC,OAqEJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AAtElC,OAwEJ,WAAW,CAAC,cACjB,IAAI,OAAM,YAAY,SAAS,EAAE,SAAS;AAzEjC,OA2EJ,cAAc,CAAC,eACpB,IAAI,OAAM,eAAe,QAAW,UAAU,EAAE,SAAS;AA5EhD,OA8EJ,eAAe,CAAC,eACrB,IAAI,OAAM,gBAAgB,QAAW,UAAU,EAAE,SAAS;AA/EjD,OAiFJ,QAAQ,CAAC,UACd,IAAI,OAAM,SAAS,QAAW,KAAK,EAAE,SAAS;AAlFrC,OAoFJ,SAAS,CAAC,WACf,IAAI,OAAM,UAAU,QAAW,MAAM,EAAE,SAAS;AArFvC,OAuFJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAxFxC,OA0FJ,KAAK,CAAC,YACX,IAAI,OAAM,MAAM,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA3FtE,OA6FJ,MAAM,CAAC,YACZ,IAAI,OAAM,OAAO,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA9F7E,IAAM,QAAN","sourcesContent":["type QueryTypesSingle = string | number | boolean;\nexport type QueryTypesList = string[] | number[] | boolean[] | Query[];\nexport type QueryTypes = QueryTypesSingle | QueryTypesList;\ntype AttributesTypes = string | string[];\n\nexport class Query {\n method: string;\n attribute: AttributesTypes | undefined;\n values: QueryTypesList | undefined;\n\n constructor(\n method: string,\n attribute?: AttributesTypes,\n values?: QueryTypes\n ) {\n this.method = method;\n this.attribute = attribute;\n\n if (values !== undefined) {\n if (Array.isArray(values)) {\n this.values = values;\n } else {\n this.values = [values] as QueryTypesList;\n }\n }\n }\n\n toString(): string {\n return JSON.stringify({\n method: this.method,\n attribute: this.attribute,\n values: this.values,\n });\n }\n\n static equal = (attribute: string, value: QueryTypes): string =>\n new Query(\"equal\", attribute, value).toString();\n\n static notEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"notEqual\", attribute, value).toString();\n\n static lessThan = (attribute: string, value: QueryTypes): string =>\n new Query(\"lessThan\", attribute, value).toString();\n\n static lessThanEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"lessThanEqual\", attribute, value).toString();\n\n static greaterThan = (attribute: string, value: QueryTypes): string =>\n new Query(\"greaterThan\", attribute, value).toString();\n\n static greaterThanEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"greaterThanEqual\", attribute, value).toString();\n\n static isNull = (attribute: string): string =>\n new Query(\"isNull\", attribute).toString();\n\n static isNotNull = (attribute: string): string =>\n new Query(\"isNotNull\", attribute).toString();\n\n static between = (attribute: string, start: string | number, end: string | number) =>\n new Query(\"between\", attribute, [start, end] as QueryTypesList).toString();\n\n static startsWith = (attribute: string, value: string): string =>\n new Query(\"startsWith\", attribute, value).toString();\n\n static endsWith = (attribute: string, value: string): string =>\n new Query(\"endsWith\", attribute, value).toString();\n\n static select = (attributes: string[]): string =>\n new Query(\"select\", undefined, attributes).toString();\n\n static search = (attribute: string, value: string): string =>\n new Query(\"search\", attribute, value).toString();\n\n static orderDesc = (attribute: string): string =>\n new Query(\"orderDesc\", attribute).toString();\n\n static orderAsc = (attribute: string): string =>\n new Query(\"orderAsc\", attribute).toString();\n\n static cursorAfter = (documentId: string): string =>\n new Query(\"cursorAfter\", undefined, documentId).toString();\n\n static cursorBefore = (documentId: string): string =>\n new Query(\"cursorBefore\", undefined, documentId).toString();\n\n static limit = (limit: number): string =>\n new Query(\"limit\", undefined, limit).toString();\n\n static offset = (offset: number): string =>\n new Query(\"offset\", undefined, offset).toString();\n\n static contains = (attribute: string, value: string | string[]): string =>\n new Query(\"contains\", attribute, value).toString();\n\n static or = (queries: string[]) =>\n new Query(\"or\", undefined, queries.map((query) => JSON.parse(query))).toString();\n\n static and = (queries: string[]) =>\n new Query(\"and\", undefined, queries.map((query) => JSON.parse(query))).toString();\n}\n"]}
package/dist/query.mjs ADDED
@@ -0,0 +1,47 @@
1
+ const _Query = class _Query {
2
+ constructor(method, attribute, values) {
3
+ this.method = method;
4
+ this.attribute = attribute;
5
+ if (values !== void 0) {
6
+ if (Array.isArray(values)) {
7
+ this.values = values;
8
+ } else {
9
+ this.values = [values];
10
+ }
11
+ }
12
+ }
13
+ toString() {
14
+ return JSON.stringify({
15
+ method: this.method,
16
+ attribute: this.attribute,
17
+ values: this.values
18
+ });
19
+ }
20
+ };
21
+ _Query.equal = (attribute, value) => new _Query("equal", attribute, value).toString();
22
+ _Query.notEqual = (attribute, value) => new _Query("notEqual", attribute, value).toString();
23
+ _Query.lessThan = (attribute, value) => new _Query("lessThan", attribute, value).toString();
24
+ _Query.lessThanEqual = (attribute, value) => new _Query("lessThanEqual", attribute, value).toString();
25
+ _Query.greaterThan = (attribute, value) => new _Query("greaterThan", attribute, value).toString();
26
+ _Query.greaterThanEqual = (attribute, value) => new _Query("greaterThanEqual", attribute, value).toString();
27
+ _Query.isNull = (attribute) => new _Query("isNull", attribute).toString();
28
+ _Query.isNotNull = (attribute) => new _Query("isNotNull", attribute).toString();
29
+ _Query.between = (attribute, start, end) => new _Query("between", attribute, [start, end]).toString();
30
+ _Query.startsWith = (attribute, value) => new _Query("startsWith", attribute, value).toString();
31
+ _Query.endsWith = (attribute, value) => new _Query("endsWith", attribute, value).toString();
32
+ _Query.select = (attributes) => new _Query("select", void 0, attributes).toString();
33
+ _Query.search = (attribute, value) => new _Query("search", attribute, value).toString();
34
+ _Query.orderDesc = (attribute) => new _Query("orderDesc", attribute).toString();
35
+ _Query.orderAsc = (attribute) => new _Query("orderAsc", attribute).toString();
36
+ _Query.cursorAfter = (documentId) => new _Query("cursorAfter", void 0, documentId).toString();
37
+ _Query.cursorBefore = (documentId) => new _Query("cursorBefore", void 0, documentId).toString();
38
+ _Query.limit = (limit) => new _Query("limit", void 0, limit).toString();
39
+ _Query.offset = (offset) => new _Query("offset", void 0, offset).toString();
40
+ _Query.contains = (attribute, value) => new _Query("contains", attribute, value).toString();
41
+ _Query.or = (queries) => new _Query("or", void 0, queries.map((query) => JSON.parse(query))).toString();
42
+ _Query.and = (queries) => new _Query("and", void 0, queries.map((query) => JSON.parse(query))).toString();
43
+ let Query = _Query;
44
+
45
+ export { Query };
46
+ //# sourceMappingURL=out.js.map
47
+ //# sourceMappingURL=query.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/query.ts"],"names":[],"mappings":"AAKO,MAAM,SAAN,MAAM,OAAM;AAAA,EAKjB,YACE,QACA,WACA,QACA;AACA,SAAK,SAAS;AACd,SAAK,YAAY;AAEjB,QAAI,WAAW,QAAW;AACxB,UAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,aAAK,SAAS;AAAA,MAChB,OAAO;AACL,aAAK,SAAS,CAAC,MAAM;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK,UAAU;AAAA,MACpB,QAAQ,KAAK;AAAA,MACb,WAAW,KAAK;AAAA,MAChB,QAAQ,KAAK;AAAA,IACf,CAAC;AAAA,EACH;AAmEF;AA/Fa,OA8BJ,QAAQ,CAAC,WAAmB,UACjC,IAAI,OAAM,SAAS,WAAW,KAAK,EAAE,SAAS;AA/BrC,OAiCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAlCxC,OAoCJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AArCxC,OAuCJ,gBAAgB,CAAC,WAAmB,UACzC,IAAI,OAAM,iBAAiB,WAAW,KAAK,EAAE,SAAS;AAxC7C,OA0CJ,cAAc,CAAC,WAAmB,UACvC,IAAI,OAAM,eAAe,WAAW,KAAK,EAAE,SAAS;AA3C3C,OA6CJ,mBAAmB,CAAC,WAAmB,UAC5C,IAAI,OAAM,oBAAoB,WAAW,KAAK,EAAE,SAAS;AA9ChD,OAgDJ,SAAS,CAAC,cACf,IAAI,OAAM,UAAU,SAAS,EAAE,SAAS;AAjD/B,OAmDJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AApDlC,OAsDJ,UAAU,CAAC,WAAmB,OAAwB,QAC3D,IAAI,OAAM,WAAW,WAAW,CAAC,OAAO,GAAG,CAAmB,EAAE,SAAS;AAvDhE,OAyDJ,aAAa,CAAC,WAAmB,UACtC,IAAI,OAAM,cAAc,WAAW,KAAK,EAAE,SAAS;AA1D1C,OA4DJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AA7DxC,OA+DJ,SAAS,CAAC,eACf,IAAI,OAAM,UAAU,QAAW,UAAU,EAAE,SAAS;AAhE3C,OAkEJ,SAAS,CAAC,WAAmB,UAClC,IAAI,OAAM,UAAU,WAAW,KAAK,EAAE,SAAS;AAnEtC,OAqEJ,YAAY,CAAC,cAClB,IAAI,OAAM,aAAa,SAAS,EAAE,SAAS;AAtElC,OAwEJ,WAAW,CAAC,cACjB,IAAI,OAAM,YAAY,SAAS,EAAE,SAAS;AAzEjC,OA2EJ,cAAc,CAAC,eACpB,IAAI,OAAM,eAAe,QAAW,UAAU,EAAE,SAAS;AA5EhD,OA8EJ,eAAe,CAAC,eACrB,IAAI,OAAM,gBAAgB,QAAW,UAAU,EAAE,SAAS;AA/EjD,OAiFJ,QAAQ,CAAC,UACd,IAAI,OAAM,SAAS,QAAW,KAAK,EAAE,SAAS;AAlFrC,OAoFJ,SAAS,CAAC,WACf,IAAI,OAAM,UAAU,QAAW,MAAM,EAAE,SAAS;AArFvC,OAuFJ,WAAW,CAAC,WAAmB,UACpC,IAAI,OAAM,YAAY,WAAW,KAAK,EAAE,SAAS;AAxFxC,OA0FJ,KAAK,CAAC,YACX,IAAI,OAAM,MAAM,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA3FtE,OA6FJ,MAAM,CAAC,YACZ,IAAI,OAAM,OAAO,QAAW,QAAQ,IAAI,CAAC,UAAU,KAAK,MAAM,KAAK,CAAC,CAAC,EAAE,SAAS;AA9F7E,IAAM,QAAN","sourcesContent":["type QueryTypesSingle = string | number | boolean;\nexport type QueryTypesList = string[] | number[] | boolean[] | Query[];\nexport type QueryTypes = QueryTypesSingle | QueryTypesList;\ntype AttributesTypes = string | string[];\n\nexport class Query {\n method: string;\n attribute: AttributesTypes | undefined;\n values: QueryTypesList | undefined;\n\n constructor(\n method: string,\n attribute?: AttributesTypes,\n values?: QueryTypes\n ) {\n this.method = method;\n this.attribute = attribute;\n\n if (values !== undefined) {\n if (Array.isArray(values)) {\n this.values = values;\n } else {\n this.values = [values] as QueryTypesList;\n }\n }\n }\n\n toString(): string {\n return JSON.stringify({\n method: this.method,\n attribute: this.attribute,\n values: this.values,\n });\n }\n\n static equal = (attribute: string, value: QueryTypes): string =>\n new Query(\"equal\", attribute, value).toString();\n\n static notEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"notEqual\", attribute, value).toString();\n\n static lessThan = (attribute: string, value: QueryTypes): string =>\n new Query(\"lessThan\", attribute, value).toString();\n\n static lessThanEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"lessThanEqual\", attribute, value).toString();\n\n static greaterThan = (attribute: string, value: QueryTypes): string =>\n new Query(\"greaterThan\", attribute, value).toString();\n\n static greaterThanEqual = (attribute: string, value: QueryTypes): string =>\n new Query(\"greaterThanEqual\", attribute, value).toString();\n\n static isNull = (attribute: string): string =>\n new Query(\"isNull\", attribute).toString();\n\n static isNotNull = (attribute: string): string =>\n new Query(\"isNotNull\", attribute).toString();\n\n static between = (attribute: string, start: string | number, end: string | number) =>\n new Query(\"between\", attribute, [start, end] as QueryTypesList).toString();\n\n static startsWith = (attribute: string, value: string): string =>\n new Query(\"startsWith\", attribute, value).toString();\n\n static endsWith = (attribute: string, value: string): string =>\n new Query(\"endsWith\", attribute, value).toString();\n\n static select = (attributes: string[]): string =>\n new Query(\"select\", undefined, attributes).toString();\n\n static search = (attribute: string, value: string): string =>\n new Query(\"search\", attribute, value).toString();\n\n static orderDesc = (attribute: string): string =>\n new Query(\"orderDesc\", attribute).toString();\n\n static orderAsc = (attribute: string): string =>\n new Query(\"orderAsc\", attribute).toString();\n\n static cursorAfter = (documentId: string): string =>\n new Query(\"cursorAfter\", undefined, documentId).toString();\n\n static cursorBefore = (documentId: string): string =>\n new Query(\"cursorBefore\", undefined, documentId).toString();\n\n static limit = (limit: number): string =>\n new Query(\"limit\", undefined, limit).toString();\n\n static offset = (offset: number): string =>\n new Query(\"offset\", undefined, offset).toString();\n\n static contains = (attribute: string, value: string | string[]): string =>\n new Query(\"contains\", attribute, value).toString();\n\n static or = (queries: string[]) =>\n new Query(\"or\", undefined, queries.map((query) => JSON.parse(query))).toString();\n\n static and = (queries: string[]) =>\n new Query(\"and\", undefined, queries.map((query) => JSON.parse(query))).toString();\n}\n"]}
@@ -0,0 +1,72 @@
1
+ /**
2
+ * Helper class to generate role strings for `Permission`.
3
+ */
4
+ declare class Role {
5
+ /**
6
+ * Grants access to anyone.
7
+ *
8
+ * This includes authenticated and unauthenticated users.
9
+ *
10
+ * @returns {string}
11
+ */
12
+ static any(): string;
13
+ /**
14
+ * Grants access to a specific user by user ID.
15
+ *
16
+ * You can optionally pass verified or unverified for
17
+ * `status` to target specific types of users.
18
+ *
19
+ * @param {string} id
20
+ * @param {string} status
21
+ * @returns {string}
22
+ */
23
+ static user(id: string, status?: string): string;
24
+ /**
25
+ * Grants access to any authenticated or anonymous user.
26
+ *
27
+ * You can optionally pass verified or unverified for
28
+ * `status` to target specific types of users.
29
+ *
30
+ * @param {string} status
31
+ * @returns {string}
32
+ */
33
+ static users(status?: string): string;
34
+ /**
35
+ * Grants access to any guest user without a session.
36
+ *
37
+ * Authenticated users don't have access to this role.
38
+ *
39
+ * @returns {string}
40
+ */
41
+ static guests(): string;
42
+ /**
43
+ * Grants access to a team by team ID.
44
+ *
45
+ * You can optionally pass a role for `role` to target
46
+ * team members with the specified role.
47
+ *
48
+ * @param {string} id
49
+ * @param {string} role
50
+ * @returns {string}
51
+ */
52
+ static team(id: string, role?: string): string;
53
+ /**
54
+ * Grants access to a specific member of a team.
55
+ *
56
+ * When the member is removed from the team, they will
57
+ * no longer have access.
58
+ *
59
+ * @param {string} id
60
+ * @returns {string}
61
+ */
62
+ static member(id: string): string;
63
+ /**
64
+ * Grants access to a user with the specified label.
65
+ *
66
+ * @param {string} name
67
+ * @returns {string}
68
+ */
69
+ static label(name: string): string;
70
+ }
71
+
72
+ export { Role };
package/dist/role.d.ts ADDED
@@ -0,0 +1,72 @@
1
+ /**
2
+ * Helper class to generate role strings for `Permission`.
3
+ */
4
+ declare class Role {
5
+ /**
6
+ * Grants access to anyone.
7
+ *
8
+ * This includes authenticated and unauthenticated users.
9
+ *
10
+ * @returns {string}
11
+ */
12
+ static any(): string;
13
+ /**
14
+ * Grants access to a specific user by user ID.
15
+ *
16
+ * You can optionally pass verified or unverified for
17
+ * `status` to target specific types of users.
18
+ *
19
+ * @param {string} id
20
+ * @param {string} status
21
+ * @returns {string}
22
+ */
23
+ static user(id: string, status?: string): string;
24
+ /**
25
+ * Grants access to any authenticated or anonymous user.
26
+ *
27
+ * You can optionally pass verified or unverified for
28
+ * `status` to target specific types of users.
29
+ *
30
+ * @param {string} status
31
+ * @returns {string}
32
+ */
33
+ static users(status?: string): string;
34
+ /**
35
+ * Grants access to any guest user without a session.
36
+ *
37
+ * Authenticated users don't have access to this role.
38
+ *
39
+ * @returns {string}
40
+ */
41
+ static guests(): string;
42
+ /**
43
+ * Grants access to a team by team ID.
44
+ *
45
+ * You can optionally pass a role for `role` to target
46
+ * team members with the specified role.
47
+ *
48
+ * @param {string} id
49
+ * @param {string} role
50
+ * @returns {string}
51
+ */
52
+ static team(id: string, role?: string): string;
53
+ /**
54
+ * Grants access to a specific member of a team.
55
+ *
56
+ * When the member is removed from the team, they will
57
+ * no longer have access.
58
+ *
59
+ * @param {string} id
60
+ * @returns {string}
61
+ */
62
+ static member(id: string): string;
63
+ /**
64
+ * Grants access to a user with the specified label.
65
+ *
66
+ * @param {string} name
67
+ * @returns {string}
68
+ */
69
+ static label(name: string): string;
70
+ }
71
+
72
+ export { Role };
package/dist/role.js ADDED
@@ -0,0 +1,96 @@
1
+ 'use strict';
2
+
3
+ class Role {
4
+ /**
5
+ * Grants access to anyone.
6
+ *
7
+ * This includes authenticated and unauthenticated users.
8
+ *
9
+ * @returns {string}
10
+ */
11
+ static any() {
12
+ return "any";
13
+ }
14
+ /**
15
+ * Grants access to a specific user by user ID.
16
+ *
17
+ * You can optionally pass verified or unverified for
18
+ * `status` to target specific types of users.
19
+ *
20
+ * @param {string} id
21
+ * @param {string} status
22
+ * @returns {string}
23
+ */
24
+ static user(id, status = "") {
25
+ if (status === "") {
26
+ return `user:${id}`;
27
+ }
28
+ return `user:${id}/${status}`;
29
+ }
30
+ /**
31
+ * Grants access to any authenticated or anonymous user.
32
+ *
33
+ * You can optionally pass verified or unverified for
34
+ * `status` to target specific types of users.
35
+ *
36
+ * @param {string} status
37
+ * @returns {string}
38
+ */
39
+ static users(status = "") {
40
+ if (status === "") {
41
+ return "users";
42
+ }
43
+ return `users/${status}`;
44
+ }
45
+ /**
46
+ * Grants access to any guest user without a session.
47
+ *
48
+ * Authenticated users don't have access to this role.
49
+ *
50
+ * @returns {string}
51
+ */
52
+ static guests() {
53
+ return "guests";
54
+ }
55
+ /**
56
+ * Grants access to a team by team ID.
57
+ *
58
+ * You can optionally pass a role for `role` to target
59
+ * team members with the specified role.
60
+ *
61
+ * @param {string} id
62
+ * @param {string} role
63
+ * @returns {string}
64
+ */
65
+ static team(id, role = "") {
66
+ if (role === "") {
67
+ return `team:${id}`;
68
+ }
69
+ return `team:${id}/${role}`;
70
+ }
71
+ /**
72
+ * Grants access to a specific member of a team.
73
+ *
74
+ * When the member is removed from the team, they will
75
+ * no longer have access.
76
+ *
77
+ * @param {string} id
78
+ * @returns {string}
79
+ */
80
+ static member(id) {
81
+ return `member:${id}`;
82
+ }
83
+ /**
84
+ * Grants access to a user with the specified label.
85
+ *
86
+ * @param {string} name
87
+ * @returns {string}
88
+ */
89
+ static label(name) {
90
+ return `label:${name}`;
91
+ }
92
+ }
93
+
94
+ exports.Role = Role;
95
+ //# sourceMappingURL=out.js.map
96
+ //# sourceMappingURL=role.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/role.ts"],"names":[],"mappings":"AAGO,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASd,OAAc,MAAc;AACxB,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAc,KAAK,IAAY,SAAiB,IAAY;AACxD,QAAI,WAAW,IAAI;AACf,aAAO,QAAQ,EAAE;AAAA,IACrB;AACA,WAAO,QAAQ,EAAE,IAAI,MAAM;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAc,MAAM,SAAiB,IAAY;AAC7C,QAAI,WAAW,IAAI;AACf,aAAO;AAAA,IACX;AACA,WAAO,SAAS,MAAM;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAc,SAAiB;AAC3B,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAc,KAAK,IAAY,OAAe,IAAY;AACtD,QAAI,SAAS,IAAI;AACb,aAAO,QAAQ,EAAE;AAAA,IACrB;AACA,WAAO,QAAQ,EAAE,IAAI,IAAI;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAc,OAAO,IAAoB;AACrC,WAAO,UAAU,EAAE;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,MAAM,MAAsB;AACtC,WAAO,SAAS,IAAI;AAAA,EACxB;AACJ","sourcesContent":["/**\n * Helper class to generate role strings for `Permission`.\n */\nexport class Role {\n\n /**\n * Grants access to anyone.\n * \n * This includes authenticated and unauthenticated users.\n * \n * @returns {string}\n */\n public static any(): string {\n return 'any'\n }\n\n /**\n * Grants access to a specific user by user ID.\n * \n * You can optionally pass verified or unverified for\n * `status` to target specific types of users.\n *\n * @param {string} id \n * @param {string} status \n * @returns {string}\n */\n public static user(id: string, status: string = ''): string {\n if (status === '') {\n return `user:${id}`\n }\n return `user:${id}/${status}`\n }\n\n /**\n * Grants access to any authenticated or anonymous user.\n * \n * You can optionally pass verified or unverified for\n * `status` to target specific types of users.\n * \n * @param {string} status \n * @returns {string}\n */\n public static users(status: string = ''): string {\n if (status === '') {\n return 'users'\n }\n return `users/${status}`\n }\n\n /**\n * Grants access to any guest user without a session.\n * \n * Authenticated users don't have access to this role.\n * \n * @returns {string}\n */\n public static guests(): string {\n return 'guests'\n }\n\n /**\n * Grants access to a team by team ID.\n * \n * You can optionally pass a role for `role` to target\n * team members with the specified role.\n * \n * @param {string} id \n * @param {string} role \n * @returns {string}\n */\n public static team(id: string, role: string = ''): string {\n if (role === '') {\n return `team:${id}`\n }\n return `team:${id}/${role}`\n }\n\n /**\n * Grants access to a specific member of a team.\n * \n * When the member is removed from the team, they will\n * no longer have access.\n * \n * @param {string} id \n * @returns {string}\n */\n public static member(id: string): string {\n return `member:${id}`\n }\n\n /**\n * Grants access to a user with the specified label.\n * \n * @param {string} name \n * @returns {string}\n */\n public static label(name: string): string {\n return `label:${name}`\n }\n}"]}
package/dist/role.mjs ADDED
@@ -0,0 +1,94 @@
1
+ class Role {
2
+ /**
3
+ * Grants access to anyone.
4
+ *
5
+ * This includes authenticated and unauthenticated users.
6
+ *
7
+ * @returns {string}
8
+ */
9
+ static any() {
10
+ return "any";
11
+ }
12
+ /**
13
+ * Grants access to a specific user by user ID.
14
+ *
15
+ * You can optionally pass verified or unverified for
16
+ * `status` to target specific types of users.
17
+ *
18
+ * @param {string} id
19
+ * @param {string} status
20
+ * @returns {string}
21
+ */
22
+ static user(id, status = "") {
23
+ if (status === "") {
24
+ return `user:${id}`;
25
+ }
26
+ return `user:${id}/${status}`;
27
+ }
28
+ /**
29
+ * Grants access to any authenticated or anonymous user.
30
+ *
31
+ * You can optionally pass verified or unverified for
32
+ * `status` to target specific types of users.
33
+ *
34
+ * @param {string} status
35
+ * @returns {string}
36
+ */
37
+ static users(status = "") {
38
+ if (status === "") {
39
+ return "users";
40
+ }
41
+ return `users/${status}`;
42
+ }
43
+ /**
44
+ * Grants access to any guest user without a session.
45
+ *
46
+ * Authenticated users don't have access to this role.
47
+ *
48
+ * @returns {string}
49
+ */
50
+ static guests() {
51
+ return "guests";
52
+ }
53
+ /**
54
+ * Grants access to a team by team ID.
55
+ *
56
+ * You can optionally pass a role for `role` to target
57
+ * team members with the specified role.
58
+ *
59
+ * @param {string} id
60
+ * @param {string} role
61
+ * @returns {string}
62
+ */
63
+ static team(id, role = "") {
64
+ if (role === "") {
65
+ return `team:${id}`;
66
+ }
67
+ return `team:${id}/${role}`;
68
+ }
69
+ /**
70
+ * Grants access to a specific member of a team.
71
+ *
72
+ * When the member is removed from the team, they will
73
+ * no longer have access.
74
+ *
75
+ * @param {string} id
76
+ * @returns {string}
77
+ */
78
+ static member(id) {
79
+ return `member:${id}`;
80
+ }
81
+ /**
82
+ * Grants access to a user with the specified label.
83
+ *
84
+ * @param {string} name
85
+ * @returns {string}
86
+ */
87
+ static label(name) {
88
+ return `label:${name}`;
89
+ }
90
+ }
91
+
92
+ export { Role };
93
+ //# sourceMappingURL=out.js.map
94
+ //# sourceMappingURL=role.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/role.ts"],"names":[],"mappings":"AAGO,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASd,OAAc,MAAc;AACxB,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAc,KAAK,IAAY,SAAiB,IAAY;AACxD,QAAI,WAAW,IAAI;AACf,aAAO,QAAQ,EAAE;AAAA,IACrB;AACA,WAAO,QAAQ,EAAE,IAAI,MAAM;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAc,MAAM,SAAiB,IAAY;AAC7C,QAAI,WAAW,IAAI;AACf,aAAO;AAAA,IACX;AACA,WAAO,SAAS,MAAM;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAc,SAAiB;AAC3B,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,OAAc,KAAK,IAAY,OAAe,IAAY;AACtD,QAAI,SAAS,IAAI;AACb,aAAO,QAAQ,EAAE;AAAA,IACrB;AACA,WAAO,QAAQ,EAAE,IAAI,IAAI;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,OAAc,OAAO,IAAoB;AACrC,WAAO,UAAU,EAAE;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,MAAM,MAAsB;AACtC,WAAO,SAAS,IAAI;AAAA,EACxB;AACJ","sourcesContent":["/**\n * Helper class to generate role strings for `Permission`.\n */\nexport class Role {\n\n /**\n * Grants access to anyone.\n * \n * This includes authenticated and unauthenticated users.\n * \n * @returns {string}\n */\n public static any(): string {\n return 'any'\n }\n\n /**\n * Grants access to a specific user by user ID.\n * \n * You can optionally pass verified or unverified for\n * `status` to target specific types of users.\n *\n * @param {string} id \n * @param {string} status \n * @returns {string}\n */\n public static user(id: string, status: string = ''): string {\n if (status === '') {\n return `user:${id}`\n }\n return `user:${id}/${status}`\n }\n\n /**\n * Grants access to any authenticated or anonymous user.\n * \n * You can optionally pass verified or unverified for\n * `status` to target specific types of users.\n * \n * @param {string} status \n * @returns {string}\n */\n public static users(status: string = ''): string {\n if (status === '') {\n return 'users'\n }\n return `users/${status}`\n }\n\n /**\n * Grants access to any guest user without a session.\n * \n * Authenticated users don't have access to this role.\n * \n * @returns {string}\n */\n public static guests(): string {\n return 'guests'\n }\n\n /**\n * Grants access to a team by team ID.\n * \n * You can optionally pass a role for `role` to target\n * team members with the specified role.\n * \n * @param {string} id \n * @param {string} role \n * @returns {string}\n */\n public static team(id: string, role: string = ''): string {\n if (role === '') {\n return `team:${id}`\n }\n return `team:${id}/${role}`\n }\n\n /**\n * Grants access to a specific member of a team.\n * \n * When the member is removed from the team, they will\n * no longer have access.\n * \n * @param {string} id \n * @returns {string}\n */\n public static member(id: string): string {\n return `member:${id}`\n }\n\n /**\n * Grants access to a user with the specified label.\n * \n * @param {string} name \n * @returns {string}\n */\n public static label(name: string): string {\n return `label:${name}`\n }\n}"]}