@twin.org/api-tenant-processor 0.0.3-next.2 → 0.0.3-next.20

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 (82) hide show
  1. package/dist/es/entities/tenant.js +25 -1
  2. package/dist/es/entities/tenant.js.map +1 -1
  3. package/dist/es/index.js +10 -2
  4. package/dist/es/index.js.map +1 -1
  5. package/dist/es/models/api/ITenantCreateRequest.js +2 -0
  6. package/dist/es/models/api/ITenantCreateRequest.js.map +1 -0
  7. package/dist/es/models/api/ITenantGetByApiKeyRequest.js +4 -0
  8. package/dist/es/models/api/ITenantGetByApiKeyRequest.js.map +1 -0
  9. package/dist/es/models/api/ITenantGetByIdRequest.js +4 -0
  10. package/dist/es/models/api/ITenantGetByIdRequest.js.map +1 -0
  11. package/dist/es/models/api/ITenantGetByPublicOriginRequest.js +4 -0
  12. package/dist/es/models/api/ITenantGetByPublicOriginRequest.js.map +1 -0
  13. package/dist/es/models/api/ITenantGetResponse.js +2 -0
  14. package/dist/es/models/api/ITenantGetResponse.js.map +1 -0
  15. package/dist/es/models/api/ITenantListRequest.js +4 -0
  16. package/dist/es/models/api/ITenantListRequest.js.map +1 -0
  17. package/dist/es/models/api/ITenantListResponse.js +2 -0
  18. package/dist/es/models/api/ITenantListResponse.js.map +1 -0
  19. package/dist/es/models/api/ITenantRemoveRequest.js +4 -0
  20. package/dist/es/models/api/ITenantRemoveRequest.js.map +1 -0
  21. package/dist/es/models/api/ITenantUpdateRequest.js +2 -0
  22. package/dist/es/models/api/ITenantUpdateRequest.js.map +1 -0
  23. package/dist/es/restEntryPoints.js +10 -0
  24. package/dist/es/restEntryPoints.js.map +1 -0
  25. package/dist/es/tenantAdminService.js +112 -15
  26. package/dist/es/tenantAdminService.js.map +1 -1
  27. package/dist/es/tenantIdContextIdHandler.js +8 -1
  28. package/dist/es/tenantIdContextIdHandler.js.map +1 -1
  29. package/dist/es/tenantProcessor.js +26 -21
  30. package/dist/es/tenantProcessor.js.map +1 -1
  31. package/dist/es/tenantRoutes.js +396 -0
  32. package/dist/es/tenantRoutes.js.map +1 -0
  33. package/dist/es/utils/tenantIdHelper.js +3 -3
  34. package/dist/es/utils/tenantIdHelper.js.map +1 -1
  35. package/dist/types/entities/tenant.d.ts +12 -0
  36. package/dist/types/index.d.ts +10 -2
  37. package/dist/types/models/api/ITenantCreateRequest.d.ts +12 -0
  38. package/dist/types/models/api/ITenantGetByApiKeyRequest.d.ts +14 -0
  39. package/dist/types/models/api/ITenantGetByIdRequest.d.ts +14 -0
  40. package/dist/types/models/api/ITenantGetByPublicOriginRequest.d.ts +14 -0
  41. package/dist/types/models/api/ITenantGetResponse.d.ts +10 -0
  42. package/dist/types/models/api/ITenantListRequest.d.ts +18 -0
  43. package/dist/types/models/api/ITenantListResponse.d.ts +17 -0
  44. package/dist/types/models/api/ITenantRemoveRequest.d.ts +14 -0
  45. package/dist/types/models/api/ITenantUpdateRequest.d.ts +19 -0
  46. package/dist/types/restEntryPoints.d.ts +2 -0
  47. package/dist/types/tenantAdminService.d.ts +30 -10
  48. package/dist/types/tenantIdContextIdHandler.d.ts +5 -0
  49. package/dist/types/tenantRoutes.d.ts +77 -0
  50. package/docs/changelog.md +278 -0
  51. package/docs/reference/classes/Tenant.md +24 -0
  52. package/docs/reference/classes/TenantAdminService.md +93 -19
  53. package/docs/reference/classes/TenantIdContextIdHandler.md +18 -0
  54. package/docs/reference/functions/generateRestRoutesTenants.md +25 -0
  55. package/docs/reference/functions/tenantByApiKey.md +31 -0
  56. package/docs/reference/functions/tenantById.md +31 -0
  57. package/docs/reference/functions/tenantByPublicOrigin.md +31 -0
  58. package/docs/reference/functions/tenantCreate.md +31 -0
  59. package/docs/reference/functions/tenantList.md +31 -0
  60. package/docs/reference/functions/tenantRemove.md +31 -0
  61. package/docs/reference/functions/tenantUpdate.md +31 -0
  62. package/docs/reference/index.md +21 -2
  63. package/docs/reference/interfaces/ITenantCreateRequest.md +17 -0
  64. package/docs/reference/interfaces/ITenantGetByApiKeyRequest.md +17 -0
  65. package/docs/reference/interfaces/ITenantGetByIdRequest.md +17 -0
  66. package/docs/reference/interfaces/ITenantGetByPublicOriginRequest.md +17 -0
  67. package/docs/reference/interfaces/ITenantGetResponse.md +11 -0
  68. package/docs/reference/interfaces/ITenantListRequest.md +23 -0
  69. package/docs/reference/interfaces/ITenantListResponse.md +23 -0
  70. package/docs/reference/interfaces/ITenantRemoveRequest.md +17 -0
  71. package/docs/reference/interfaces/ITenantUpdateRequest.md +25 -0
  72. package/docs/reference/variables/tagsTenants.md +5 -0
  73. package/locales/en.json +4 -0
  74. package/package.json +2 -2
  75. package/dist/es/models/ITenant.js +0 -4
  76. package/dist/es/models/ITenant.js.map +0 -1
  77. package/dist/es/models/ITenantAdminComponent.js +0 -2
  78. package/dist/es/models/ITenantAdminComponent.js.map +0 -1
  79. package/dist/types/models/ITenant.d.ts +0 -21
  80. package/dist/types/models/ITenantAdminComponent.d.ts +0 -41
  81. package/docs/reference/interfaces/ITenant.md +0 -35
  82. package/docs/reference/interfaces/ITenantAdminComponent.md +0 -123
package/docs/reference/interfaces/ITenantAdminComponent.md DELETED
@@ -1,123 +0,0 @@
1
- # Interface: ITenantAdminComponent
2
-
3
- Configuration for the tenant admin component
4
-
5
- ## Extends
6
-
7
- - `IComponent`
8
-
9
- ## Methods
10
-
11
- ### get()
12
-
13
- > **get**(`tenantId`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
14
-
15
- Get a tenant by its id.
16
-
17
- #### Parameters
18
-
19
- ##### tenantId
20
-
21
- `string`
22
-
23
- The id of the tenant.
24
-
25
- #### Returns
26
-
27
- `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
28
-
29
- The tenant or undefined if not found.
30
-
31
- ***
32
-
33
- ### getByApiKey()
34
-
35
- > **getByApiKey**(`apiKey`): `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
36
-
37
- Get a tenant by its api key.
38
-
39
- #### Parameters
40
-
41
- ##### apiKey
42
-
43
- `string`
44
-
45
- The api key of the tenant.
46
-
47
- #### Returns
48
-
49
- `Promise`\<[`ITenant`](ITenant.md) \| `undefined`\>
50
-
51
- The tenant or undefined if not found.
52
-
53
- ***
54
-
55
- ### set()
56
-
57
- > **set**(`tenant`): `Promise`\<`void`\>
58
-
59
- Set a tenant.
60
-
61
- #### Parameters
62
-
63
- ##### tenant
64
-
65
- [`ITenant`](ITenant.md)
66
-
67
- The tenant to store.
68
-
69
- #### Returns
70
-
71
- `Promise`\<`void`\>
72
-
73
- Nothing.
74
-
75
- ***
76
-
77
- ### remove()
78
-
79
- > **remove**(`tenantId`): `Promise`\<`void`\>
80
-
81
- Remove a tenant by its id.
82
-
83
- #### Parameters
84
-
85
- ##### tenantId
86
-
87
- `string`
88
-
89
- The id of the tenant.
90
-
91
- #### Returns
92
-
93
- `Promise`\<`void`\>
94
-
95
- Nothing.
96
-
97
- ***
98
-
99
- ### query()
100
-
101
- > **query**(`cursor?`, `limit?`): `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
102
-
103
- Query tenants with pagination.
104
-
105
- #### Parameters
106
-
107
- ##### cursor?
108
-
109
- `string`
110
-
111
- The cursor to start from.
112
-
113
- ##### limit?
114
-
115
- `number`
116
-
117
- The maximum number of tenants to return.
118
-
119
- #### Returns
120
-
121
- `Promise`\<\{ `tenants`: [`ITenant`](ITenant.md)[]; `cursor?`: `string`; \}\>
122
-
123
- The tenants and the next cursor if more tenants are available.