@dereekb/zoom 13.11.14 → 13.11.15
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.
- package/index.cjs.js +79 -67
- package/index.esm.js +79 -67
- package/nestjs/index.cjs.js +53 -49
- package/nestjs/index.esm.js +53 -49
- package/nestjs/package.json +5 -5
- package/nestjs/src/lib/oauth/oauth.config.d.ts +3 -3
- package/nestjs/src/lib/oauth/oauth.module.d.ts +4 -4
- package/nestjs/src/lib/oauth/oauth.service.d.ts +11 -10
- package/nestjs/src/lib/webhook/webhook.zoom.module.d.ts +2 -2
- package/nestjs/src/lib/webhook/webhook.zoom.validate.d.ts +1 -1
- package/nestjs/src/lib/webhook/webhook.zoom.verify.d.ts +3 -3
- package/nestjs/src/lib/zoom/zoom.module.d.ts +4 -4
- package/package.json +4 -4
- package/src/lib/oauth/oauth.api.d.ts +5 -5
- package/src/lib/oauth/oauth.d.ts +3 -2
- package/src/lib/oauth/oauth.error.api.d.ts +5 -5
- package/src/lib/oauth/oauth.factory.d.ts +5 -3
- package/src/lib/zoom/zoom.api.meeting.d.ts +28 -25
- package/src/lib/zoom/zoom.api.user.d.ts +5 -4
- package/src/lib/zoom/zoom.api.user.type.d.ts +2 -2
- package/src/lib/zoom/zoom.error.api.d.ts +5 -5
- package/src/lib/zoom/zoom.factory.d.ts +3 -2
- package/src/lib/zoom.api.page.d.ts +4 -3
- package/src/lib/zoom.error.api.d.ts +13 -11
- package/src/lib/zoom.limit.d.ts +2 -2
package/nestjs/index.esm.js
CHANGED
|
@@ -89,9 +89,9 @@ function _define_property$8(obj, key, value) {
|
|
|
89
89
|
/**
|
|
90
90
|
* Reads a ZoomOAuthServiceConfig from the NestJS ConfigService using environment variables.
|
|
91
91
|
*
|
|
92
|
-
* @param configService The NestJS ConfigService to read from
|
|
93
|
-
* @param prefix Optional prefix for environment variable names
|
|
94
|
-
* @returns A validated ZoomOAuthServiceConfig
|
|
92
|
+
* @param configService - The NestJS ConfigService to read from.
|
|
93
|
+
* @param prefix - Optional prefix for environment variable names.
|
|
94
|
+
* @returns A validated ZoomOAuthServiceConfig.
|
|
95
95
|
*/ function readZoomOAuthServiceConfigFromConfigService(configService, prefix) {
|
|
96
96
|
var prefixString = characterPrefixSuffixInstance({
|
|
97
97
|
suffix: '_',
|
|
@@ -426,7 +426,7 @@ function updateZoomCacheCapturingError(cache, accessToken) {
|
|
|
426
426
|
/**
|
|
427
427
|
* Default error logging function for merged cache service update failures.
|
|
428
428
|
*
|
|
429
|
-
* @param failedUpdates Array of failed cache update results with their errors
|
|
429
|
+
* @param failedUpdates - Array of failed cache update results with their errors.
|
|
430
430
|
*/ function logMergeZoomOAuthAccessTokenCacheServiceErrorFunction(failedUpdates) {
|
|
431
431
|
console.warn("mergeZoomOAuthAccessTokenCacheServices(): failed updating ".concat(failedUpdates.length, " caches."));
|
|
432
432
|
failedUpdates.forEach(function(param, i) {
|
|
@@ -446,9 +446,10 @@ function updateZoomCacheCapturingError(cache, accessToken) {
|
|
|
446
446
|
* never short-circuits the lookup. Updates run across all services in parallel via
|
|
447
447
|
* `Promise.allSettled`, mirroring the previous behavior, with optional error logging.
|
|
448
448
|
*
|
|
449
|
-
* @param inputServicesToMerge Must include at least one service. Empty arrays will throw an error.
|
|
450
|
-
* @param logError Optional error logging configuration. Pass a function, true for default logging, or false to disable.
|
|
451
|
-
* @returns A merged ZoomOAuthAccessTokenCacheService
|
|
449
|
+
* @param inputServicesToMerge - Must include at least one service. Empty arrays will throw an error.
|
|
450
|
+
* @param logError - Optional error logging configuration. Pass a function, true for default logging, or false to disable.
|
|
451
|
+
* @returns A merged ZoomOAuthAccessTokenCacheService.
|
|
452
|
+
* @throws {Error} When `inputServicesToMerge` is empty.
|
|
452
453
|
*/ function mergeZoomOAuthAccessTokenCacheServices(inputServicesToMerge, logError) {
|
|
453
454
|
var allServices = _to_consumable_array$2(inputServicesToMerge);
|
|
454
455
|
var logErrorFunction = typeof logError === 'function' ? logError : logError !== false ? logMergeZoomOAuthAccessTokenCacheServiceErrorFunction : undefined;
|
|
@@ -520,9 +521,9 @@ function updateZoomCacheCapturingError(cache, accessToken) {
|
|
|
520
521
|
*
|
|
521
522
|
* Backed by {@link inMemoryAsyncValueCache} so all consumers share the same single token slot.
|
|
522
523
|
*
|
|
523
|
-
* @param existingToken Optional initial token to seed the cache with
|
|
524
|
-
* @param logAccessToConsole Whether to log token access to console
|
|
525
|
-
* @returns A memory-backed ZoomOAuthAccessTokenCacheService
|
|
524
|
+
* @param existingToken - Optional initial token to seed the cache with.
|
|
525
|
+
* @param logAccessToConsole - Whether to log token access to console.
|
|
526
|
+
* @returns A memory-backed ZoomOAuthAccessTokenCacheService.
|
|
526
527
|
*/ function memoryZoomOAuthAccessTokenCacheService(existingToken, logAccessToConsole) {
|
|
527
528
|
var cache = inMemoryAsyncValueCache(existingToken);
|
|
528
529
|
function loadZoomAccessTokenCache() {
|
|
@@ -591,22 +592,26 @@ var DEFAULT_FILE_ZOOM_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoom-acce
|
|
|
591
592
|
* Reviver applied to the cached file payload on load so `expiresAt` is always a `Date`
|
|
592
593
|
* regardless of how it was serialized.
|
|
593
594
|
*
|
|
594
|
-
* @param raw -
|
|
595
|
-
* @returns
|
|
595
|
+
* @param raw - The raw JSON-parsed file payload.
|
|
596
|
+
* @returns The revived ZoomAccessToken, or undefined when the payload is empty/invalid.
|
|
596
597
|
*/ function reviveZoomAccessTokenFile(raw) {
|
|
598
|
+
var result;
|
|
597
599
|
if (raw == null || (typeof raw === "undefined" ? "undefined" : _type_of(raw)) !== 'object') {
|
|
598
|
-
|
|
599
|
-
}
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
600
|
+
result = undefined;
|
|
601
|
+
} else {
|
|
602
|
+
var wrapper = raw;
|
|
603
|
+
var token = wrapper.token;
|
|
604
|
+
if (token == null) {
|
|
605
|
+
result = undefined;
|
|
606
|
+
} else {
|
|
607
|
+
var rawExpiresAt = token.expiresAt;
|
|
608
|
+
var expiresAt = rawExpiresAt != null && !_instanceof(rawExpiresAt, Date) ? new Date(rawExpiresAt) : rawExpiresAt;
|
|
609
|
+
result = _object_spread_props$2(_object_spread$3({}, token), {
|
|
610
|
+
expiresAt: expiresAt
|
|
611
|
+
});
|
|
612
|
+
}
|
|
604
613
|
}
|
|
605
|
-
|
|
606
|
-
var expiresAt = rawExpiresAt != null && !_instanceof(rawExpiresAt, Date) ? new Date(rawExpiresAt) : rawExpiresAt;
|
|
607
|
-
return _object_spread_props$2(_object_spread$3({}, token), {
|
|
608
|
-
expiresAt: expiresAt
|
|
609
|
-
});
|
|
614
|
+
return result;
|
|
610
615
|
}
|
|
611
616
|
/**
|
|
612
617
|
* Creates a ZoomOAuthAccessTokenCacheService that reads and writes the access token to the file system.
|
|
@@ -616,9 +621,9 @@ var DEFAULT_FILE_ZOOM_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoom-acce
|
|
|
616
621
|
*
|
|
617
622
|
* Useful for testing.
|
|
618
623
|
*
|
|
619
|
-
* @param filename Path to the token cache file
|
|
620
|
-
* @param useMemoryCache Whether to also cache tokens in memory for faster access
|
|
621
|
-
* @returns A file-system-backed ZoomOAuthAccessTokenCacheService
|
|
624
|
+
* @param filename - Path to the token cache file.
|
|
625
|
+
* @param useMemoryCache - Whether to also cache tokens in memory for faster access.
|
|
626
|
+
* @returns A file-system-backed ZoomOAuthAccessTokenCacheService.
|
|
622
627
|
*/ function fileZoomOAuthAccessTokenCacheService() {
|
|
623
628
|
var filename = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_FILE_ZOOM_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH, useMemoryCache = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : true;
|
|
624
629
|
var innerCacheInput = {
|
|
@@ -677,7 +682,7 @@ var DEFAULT_FILE_ZOOM_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoom-acce
|
|
|
677
682
|
}
|
|
678
683
|
function readTokenFile() {
|
|
679
684
|
return _async_to_generator$2(function() {
|
|
680
|
-
var raw, token;
|
|
685
|
+
var raw, result, token;
|
|
681
686
|
return _ts_generator$2(this, function(_state) {
|
|
682
687
|
switch(_state.label){
|
|
683
688
|
case 0:
|
|
@@ -688,17 +693,16 @@ var DEFAULT_FILE_ZOOM_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoom-acce
|
|
|
688
693
|
case 1:
|
|
689
694
|
raw = _state.sent();
|
|
690
695
|
if (raw == null) {
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
696
|
+
result = undefined;
|
|
697
|
+
} else {
|
|
698
|
+
token = reviveZoomAccessTokenFile(raw);
|
|
699
|
+
result = {
|
|
700
|
+
token: token
|
|
701
|
+
};
|
|
695
702
|
}
|
|
696
|
-
token = reviveZoomAccessTokenFile(raw);
|
|
697
703
|
return [
|
|
698
704
|
2,
|
|
699
|
-
|
|
700
|
-
token: token
|
|
701
|
-
}
|
|
705
|
+
result
|
|
702
706
|
];
|
|
703
707
|
}
|
|
704
708
|
});
|
|
@@ -886,16 +890,16 @@ function _unsupported_iterable_to_array$1(o, minLen) {
|
|
|
886
890
|
/**
|
|
887
891
|
* Default factory function for creating ZoomOAuthServiceConfig from ConfigService.
|
|
888
892
|
*
|
|
889
|
-
* @param configService The NestJS ConfigService
|
|
890
|
-
* @returns A validated ZoomOAuthServiceConfig
|
|
893
|
+
* @param configService - The NestJS ConfigService.
|
|
894
|
+
* @returns A validated ZoomOAuthServiceConfig.
|
|
891
895
|
*/ function zoomOAuthServiceConfigFactory(configService) {
|
|
892
896
|
return readZoomOAuthServiceConfigFromConfigService(configService);
|
|
893
897
|
}
|
|
894
898
|
/**
|
|
895
899
|
* Convenience function used to generate ModuleMetadata for an app's ZoomOAuthModule.
|
|
896
900
|
*
|
|
897
|
-
* @param config The configuration for the module metadata
|
|
898
|
-
* @returns Module metadata for the Zoom OAuth module
|
|
901
|
+
* @param config - The configuration for the module metadata.
|
|
902
|
+
* @returns Module metadata for the Zoom OAuth module.
|
|
899
903
|
*/ function appZoomOAuthModuleMetadata(config) {
|
|
900
904
|
var _config_zoomOAuthServiceConfigFactory;
|
|
901
905
|
var dependencyModule = config.dependencyModule, imports = config.imports, exports = config.exports, providers = config.providers;
|
|
@@ -1071,10 +1075,10 @@ var zoomEventHandlerConfigurerFactory = handlerConfigurerFactory({
|
|
|
1071
1075
|
/**
|
|
1072
1076
|
* Verifies a Zoom webhook event header.
|
|
1073
1077
|
*
|
|
1074
|
-
* @
|
|
1078
|
+
* @param zoomSecretToken - The Zoom secret token.
|
|
1079
|
+
* @returns Verifies a Zoom webhook event.
|
|
1075
1080
|
*
|
|
1076
|
-
* @
|
|
1077
|
-
* @returns A function that verifies a Zoom webhook event.
|
|
1081
|
+
* @see https://developers.zoom.us/docs/api/webhooks/#verify-with-zooms-header
|
|
1078
1082
|
*/ function zoomWebhookEventVerifier(zoomSecretToken) {
|
|
1079
1083
|
return function(request, _rawBody) {
|
|
1080
1084
|
var requestBodyString = String(request.body);
|
|
@@ -1095,7 +1099,7 @@ var ZOOM_WEBHOOK_URL_VALIDATION_EVENT_TYPE = 'endpoint.url_validation';
|
|
|
1095
1099
|
/**
|
|
1096
1100
|
* Creates a ZoomWebhookEventValidationFunction.
|
|
1097
1101
|
*
|
|
1098
|
-
* @param zoomSecretToken The secret token used to validate the event.
|
|
1102
|
+
* @param zoomSecretToken - The secret token used to validate the event.
|
|
1099
1103
|
* @returns A ZoomWebhookEventValidationFunction.
|
|
1100
1104
|
*/ function zoomWebhookEventValidationFunction(zoomSecretToken) {
|
|
1101
1105
|
return function(event) {
|
|
@@ -1589,8 +1593,8 @@ function _class_call_check$2(instance, Constructor) {
|
|
|
1589
1593
|
/**
|
|
1590
1594
|
* Factory function that creates ZoomWebhookServiceConfig from NestJS ConfigService.
|
|
1591
1595
|
*
|
|
1592
|
-
* @param configService The NestJS ConfigService
|
|
1593
|
-
* @returns A validated ZoomWebhookServiceConfig
|
|
1596
|
+
* @param configService - The NestJS ConfigService.
|
|
1597
|
+
* @returns A validated ZoomWebhookServiceConfig.
|
|
1594
1598
|
*/ function zoomWebhookServiceConfigFactory(configService) {
|
|
1595
1599
|
var config = {
|
|
1596
1600
|
webhookConfig: {
|
|
@@ -1881,8 +1885,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
1881
1885
|
/**
|
|
1882
1886
|
* Default factory function for creating ZoomServiceConfig from ConfigService.
|
|
1883
1887
|
*
|
|
1884
|
-
* @param _configService The NestJS ConfigService (unused currently)
|
|
1885
|
-
* @returns A validated ZoomServiceConfig
|
|
1888
|
+
* @param _configService - The NestJS ConfigService (unused currently)
|
|
1889
|
+
* @returns A validated ZoomServiceConfig.
|
|
1886
1890
|
*/ function zoomServiceConfigFactory(_configService) {
|
|
1887
1891
|
var config = {
|
|
1888
1892
|
zoom: {}
|
|
@@ -1893,8 +1897,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
1893
1897
|
/**
|
|
1894
1898
|
* Convenience function used to generate ModuleMetadata for an app's ZoomModule.
|
|
1895
1899
|
*
|
|
1896
|
-
* @param config The configuration for the module metadata
|
|
1897
|
-
* @returns Module metadata for the Zoom module
|
|
1900
|
+
* @param config - The configuration for the module metadata.
|
|
1901
|
+
* @returns Module metadata for the Zoom module.
|
|
1898
1902
|
*/ function appZoomModuleMetadata(config) {
|
|
1899
1903
|
var dependencyModule = config.dependencyModule, imports = config.imports, exports = config.exports, providers = config.providers;
|
|
1900
1904
|
var dependencyModuleImport = dependencyModule ? [
|
package/nestjs/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dereekb/zoom/nestjs",
|
|
3
|
-
"version": "13.11.
|
|
3
|
+
"version": "13.11.15",
|
|
4
4
|
"peerDependencies": {
|
|
5
|
-
"@dereekb/nestjs": "13.11.
|
|
6
|
-
"@dereekb/rxjs": "13.11.
|
|
7
|
-
"@dereekb/util": "13.11.
|
|
8
|
-
"@dereekb/zoom": "13.11.
|
|
5
|
+
"@dereekb/nestjs": "13.11.15",
|
|
6
|
+
"@dereekb/rxjs": "13.11.15",
|
|
7
|
+
"@dereekb/util": "13.11.15",
|
|
8
|
+
"@dereekb/zoom": "13.11.15",
|
|
9
9
|
"@nestjs/common": "^11.1.19",
|
|
10
10
|
"@nestjs/config": "^4.0.4",
|
|
11
11
|
"express": "^5.2.1"
|
|
@@ -14,8 +14,8 @@ export declare abstract class ZoomOAuthServiceConfig {
|
|
|
14
14
|
/**
|
|
15
15
|
* Reads a ZoomOAuthServiceConfig from the NestJS ConfigService using environment variables.
|
|
16
16
|
*
|
|
17
|
-
* @param configService The NestJS ConfigService to read from
|
|
18
|
-
* @param prefix Optional prefix for environment variable names
|
|
19
|
-
* @returns A validated ZoomOAuthServiceConfig
|
|
17
|
+
* @param configService - The NestJS ConfigService to read from.
|
|
18
|
+
* @param prefix - Optional prefix for environment variable names.
|
|
19
|
+
* @returns A validated ZoomOAuthServiceConfig.
|
|
20
20
|
*/
|
|
21
21
|
export declare function readZoomOAuthServiceConfigFromConfigService(configService: ConfigService, prefix?: string): ZoomOAuthServiceConfig;
|
|
@@ -6,8 +6,8 @@ export type ZoomOAuthServiceConfigFactory = (configService: ConfigService) => Zo
|
|
|
6
6
|
/**
|
|
7
7
|
* Default factory function for creating ZoomOAuthServiceConfig from ConfigService.
|
|
8
8
|
*
|
|
9
|
-
* @param configService The NestJS ConfigService
|
|
10
|
-
* @returns A validated ZoomOAuthServiceConfig
|
|
9
|
+
* @param configService - The NestJS ConfigService.
|
|
10
|
+
* @returns A validated ZoomOAuthServiceConfig.
|
|
11
11
|
*/
|
|
12
12
|
export declare function zoomOAuthServiceConfigFactory(configService: ConfigService): ZoomOAuthServiceConfig;
|
|
13
13
|
export interface ProvideAppZoomOAuthMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
|
|
@@ -28,7 +28,7 @@ export interface ProvideAppZoomOAuthMetadataConfig extends Pick<ModuleMetadata,
|
|
|
28
28
|
/**
|
|
29
29
|
* Convenience function used to generate ModuleMetadata for an app's ZoomOAuthModule.
|
|
30
30
|
*
|
|
31
|
-
* @param config The configuration for the module metadata
|
|
32
|
-
* @returns Module metadata for the Zoom OAuth module
|
|
31
|
+
* @param config - The configuration for the module metadata.
|
|
32
|
+
* @returns Module metadata for the Zoom OAuth module.
|
|
33
33
|
*/
|
|
34
34
|
export declare function appZoomOAuthModuleMetadata(config: ProvideAppZoomOAuthMetadataConfig): ModuleMetadata;
|
|
@@ -22,7 +22,7 @@ export type LogMergeZoomOAuthAccessTokenCacheServiceErrorFunction = (failedUpdat
|
|
|
22
22
|
/**
|
|
23
23
|
* Default error logging function for merged cache service update failures.
|
|
24
24
|
*
|
|
25
|
-
* @param failedUpdates Array of failed cache update results with their errors
|
|
25
|
+
* @param failedUpdates - Array of failed cache update results with their errors.
|
|
26
26
|
*/
|
|
27
27
|
export declare function logMergeZoomOAuthAccessTokenCacheServiceErrorFunction(failedUpdates: (readonly [ZoomAccessTokenCache, unknown])[]): void;
|
|
28
28
|
/**
|
|
@@ -37,9 +37,10 @@ export declare function logMergeZoomOAuthAccessTokenCacheServiceErrorFunction(fa
|
|
|
37
37
|
* never short-circuits the lookup. Updates run across all services in parallel via
|
|
38
38
|
* `Promise.allSettled`, mirroring the previous behavior, with optional error logging.
|
|
39
39
|
*
|
|
40
|
-
* @param inputServicesToMerge Must include at least one service. Empty arrays will throw an error.
|
|
41
|
-
* @param logError Optional error logging configuration. Pass a function, true for default logging, or false to disable.
|
|
42
|
-
* @returns A merged ZoomOAuthAccessTokenCacheService
|
|
40
|
+
* @param inputServicesToMerge - Must include at least one service. Empty arrays will throw an error.
|
|
41
|
+
* @param logError - Optional error logging configuration. Pass a function, true for default logging, or false to disable.
|
|
42
|
+
* @returns A merged ZoomOAuthAccessTokenCacheService.
|
|
43
|
+
* @throws {Error} When `inputServicesToMerge` is empty.
|
|
43
44
|
*/
|
|
44
45
|
export declare function mergeZoomOAuthAccessTokenCacheServices(inputServicesToMerge: ZoomOAuthAccessTokenCacheService[], logError?: Maybe<boolean | LogMergeZoomOAuthAccessTokenCacheServiceErrorFunction>): ZoomOAuthAccessTokenCacheService;
|
|
45
46
|
/**
|
|
@@ -47,9 +48,9 @@ export declare function mergeZoomOAuthAccessTokenCacheServices(inputServicesToMe
|
|
|
47
48
|
*
|
|
48
49
|
* Backed by {@link inMemoryAsyncValueCache} so all consumers share the same single token slot.
|
|
49
50
|
*
|
|
50
|
-
* @param existingToken Optional initial token to seed the cache with
|
|
51
|
-
* @param logAccessToConsole Whether to log token access to console
|
|
52
|
-
* @returns A memory-backed ZoomOAuthAccessTokenCacheService
|
|
51
|
+
* @param existingToken - Optional initial token to seed the cache with.
|
|
52
|
+
* @param logAccessToConsole - Whether to log token access to console.
|
|
53
|
+
* @returns A memory-backed ZoomOAuthAccessTokenCacheService.
|
|
53
54
|
*/
|
|
54
55
|
export declare function memoryZoomOAuthAccessTokenCacheService(existingToken?: Maybe<ZoomAccessToken>, logAccessToConsole?: boolean): ZoomOAuthAccessTokenCacheService;
|
|
55
56
|
export interface FileSystemZoomOAuthAccessTokenCacheService extends ZoomOAuthAccessTokenCacheService {
|
|
@@ -69,8 +70,8 @@ export type ZoomOAuthAccessTokenCacheFileContent = {
|
|
|
69
70
|
*
|
|
70
71
|
* Useful for testing.
|
|
71
72
|
*
|
|
72
|
-
* @param filename Path to the token cache file
|
|
73
|
-
* @param useMemoryCache Whether to also cache tokens in memory for faster access
|
|
74
|
-
* @returns A file-system-backed ZoomOAuthAccessTokenCacheService
|
|
73
|
+
* @param filename - Path to the token cache file.
|
|
74
|
+
* @param useMemoryCache - Whether to also cache tokens in memory for faster access.
|
|
75
|
+
* @returns A file-system-backed ZoomOAuthAccessTokenCacheService.
|
|
75
76
|
*/
|
|
76
77
|
export declare function fileZoomOAuthAccessTokenCacheService(filename?: string, useMemoryCache?: boolean): FileSystemZoomOAuthAccessTokenCacheService;
|
|
@@ -3,8 +3,8 @@ import { ZoomWebhookServiceConfig } from './webhook.zoom.config';
|
|
|
3
3
|
/**
|
|
4
4
|
* Factory function that creates ZoomWebhookServiceConfig from NestJS ConfigService.
|
|
5
5
|
*
|
|
6
|
-
* @param configService The NestJS ConfigService
|
|
7
|
-
* @returns A validated ZoomWebhookServiceConfig
|
|
6
|
+
* @param configService - The NestJS ConfigService.
|
|
7
|
+
* @returns A validated ZoomWebhookServiceConfig.
|
|
8
8
|
*/
|
|
9
9
|
export declare function zoomWebhookServiceConfigFactory(configService: ConfigService): ZoomWebhookServiceConfig;
|
|
10
10
|
/**
|
|
@@ -11,7 +11,7 @@ export type ZoomWebhookEventValidationFunction = (event: ZoomWebhookUrlValidatio
|
|
|
11
11
|
/**
|
|
12
12
|
* Creates a ZoomWebhookEventValidationFunction.
|
|
13
13
|
*
|
|
14
|
-
* @param zoomSecretToken The secret token used to validate the event.
|
|
14
|
+
* @param zoomSecretToken - The secret token used to validate the event.
|
|
15
15
|
* @returns A ZoomWebhookEventValidationFunction.
|
|
16
16
|
*/
|
|
17
17
|
export declare function zoomWebhookEventValidationFunction(zoomSecretToken: ZoomSecretToken): ZoomWebhookEventValidationFunction;
|
|
@@ -12,9 +12,9 @@ export type ZoomWebhookEventVerifier = (req: Request, _rawBody: Buffer) => ZoomW
|
|
|
12
12
|
/**
|
|
13
13
|
* Verifies a Zoom webhook event header.
|
|
14
14
|
*
|
|
15
|
-
* @
|
|
15
|
+
* @param zoomSecretToken - The Zoom secret token.
|
|
16
|
+
* @returns Verifies a Zoom webhook event.
|
|
16
17
|
*
|
|
17
|
-
* @
|
|
18
|
-
* @returns A function that verifies a Zoom webhook event.
|
|
18
|
+
* @see https://developers.zoom.us/docs/api/webhooks/#verify-with-zooms-header
|
|
19
19
|
*/
|
|
20
20
|
export declare function zoomWebhookEventVerifier(zoomSecretToken: ZoomSecretToken): ZoomWebhookEventVerifier;
|
|
@@ -5,8 +5,8 @@ import { type Maybe } from '@dereekb/util';
|
|
|
5
5
|
/**
|
|
6
6
|
* Default factory function for creating ZoomServiceConfig from ConfigService.
|
|
7
7
|
*
|
|
8
|
-
* @param _configService The NestJS ConfigService (unused currently)
|
|
9
|
-
* @returns A validated ZoomServiceConfig
|
|
8
|
+
* @param _configService - The NestJS ConfigService (unused currently)
|
|
9
|
+
* @returns A validated ZoomServiceConfig.
|
|
10
10
|
*/
|
|
11
11
|
export declare function zoomServiceConfigFactory(_configService: ConfigService): ZoomServiceConfig;
|
|
12
12
|
export interface ProvideAppZoomMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
|
|
@@ -21,7 +21,7 @@ export interface ProvideAppZoomMetadataConfig extends Pick<ModuleMetadata, 'impo
|
|
|
21
21
|
/**
|
|
22
22
|
* Convenience function used to generate ModuleMetadata for an app's ZoomModule.
|
|
23
23
|
*
|
|
24
|
-
* @param config The configuration for the module metadata
|
|
25
|
-
* @returns Module metadata for the Zoom module
|
|
24
|
+
* @param config - The configuration for the module metadata.
|
|
25
|
+
* @returns Module metadata for the Zoom module.
|
|
26
26
|
*/
|
|
27
27
|
export declare function appZoomModuleMetadata(config: ProvideAppZoomMetadataConfig): ModuleMetadata;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dereekb/zoom",
|
|
3
|
-
"version": "13.11.
|
|
3
|
+
"version": "13.11.15",
|
|
4
4
|
"exports": {
|
|
5
5
|
"./nestjs": {
|
|
6
6
|
"module": "./nestjs/index.esm.js",
|
|
@@ -17,9 +17,9 @@
|
|
|
17
17
|
}
|
|
18
18
|
},
|
|
19
19
|
"peerDependencies": {
|
|
20
|
-
"@dereekb/nestjs": "13.11.
|
|
21
|
-
"@dereekb/rxjs": "13.11.
|
|
22
|
-
"@dereekb/util": "13.11.
|
|
20
|
+
"@dereekb/nestjs": "13.11.15",
|
|
21
|
+
"@dereekb/rxjs": "13.11.15",
|
|
22
|
+
"@dereekb/util": "13.11.15",
|
|
23
23
|
"@nestjs/common": "^11.1.19",
|
|
24
24
|
"@nestjs/config": "^4.0.4",
|
|
25
25
|
"express": "^5.2.1",
|
|
@@ -38,15 +38,15 @@ export declare function userAccessToken(context: ZoomOAuthContext): (input: Zoom
|
|
|
38
38
|
/**
|
|
39
39
|
* Builds a FetchJsonInput for Zoom OAuth API calls with Basic auth.
|
|
40
40
|
*
|
|
41
|
-
* @param context The Zoom OAuth context
|
|
42
|
-
* @param input Optional override for client credentials
|
|
43
|
-
* @returns A configured FetchJsonInput for the OAuth API call
|
|
41
|
+
* @param context - The Zoom OAuth context.
|
|
42
|
+
* @param input - Optional override for client credentials.
|
|
43
|
+
* @returns A configured FetchJsonInput for the OAuth API call.
|
|
44
44
|
*/
|
|
45
45
|
export declare function zoomOAuthApiFetchJsonInput(context: ZoomOAuthContext, input?: Maybe<ZoomOAuthServerAccessTokenInput>): FetchJsonInput;
|
|
46
46
|
/**
|
|
47
47
|
* Generates a Basic Authorization header value for Zoom OAuth.
|
|
48
48
|
*
|
|
49
|
-
* @param input The client ID and secret pair
|
|
50
|
-
* @returns The Base64-encoded Basic auth header value
|
|
49
|
+
* @param input - The client ID and secret pair.
|
|
50
|
+
* @returns The Base64-encoded Basic auth header value.
|
|
51
51
|
*/
|
|
52
52
|
export declare function zoomOAuthServerBasicAuthorizationHeaderValue(input: ZoomAuthClientIdAndSecretPair): string;
|
package/src/lib/oauth/oauth.d.ts
CHANGED
|
@@ -68,8 +68,9 @@ export type ZoomAccessTokenStringFactory = () => Promise<ZoomAccessTokenString>;
|
|
|
68
68
|
/**
|
|
69
69
|
* Generates a new ZoomAccessTokenStringFactory from a ZoomAccessTokenFactory.
|
|
70
70
|
*
|
|
71
|
-
* @param zoomAccessTokenFactory The factory to extract the token string from
|
|
72
|
-
* @returns A factory that returns the access token string
|
|
71
|
+
* @param zoomAccessTokenFactory - The factory to extract the token string from.
|
|
72
|
+
* @returns A factory that returns the access token string.
|
|
73
|
+
*
|
|
73
74
|
* @__NO_SIDE_EFFECTS__
|
|
74
75
|
*/
|
|
75
76
|
export declare function zoomAccessTokenStringFactory(zoomAccessTokenFactory: ZoomAccessTokenFactory): ZoomAccessTokenStringFactory;
|
|
@@ -28,16 +28,16 @@ export declare const logZoomOAuthErrorToConsole: import("..").LogZoomServerError
|
|
|
28
28
|
/**
|
|
29
29
|
* Parses a FetchResponseError into a typed Zoom OAuth error.
|
|
30
30
|
*
|
|
31
|
-
* @param responseError The fetch response error to parse
|
|
32
|
-
* @returns The parsed error, or undefined if parsing fails
|
|
31
|
+
* @param responseError - The fetch response error to parse.
|
|
32
|
+
* @returns The parsed error, or undefined if parsing fails.
|
|
33
33
|
*/
|
|
34
34
|
export declare function parseZoomOAuthError(responseError: FetchResponseError): Promise<ParsedZoomServerError>;
|
|
35
35
|
/**
|
|
36
36
|
* Parses a ZoomServerErrorData into a Zoom OAuth-specific error.
|
|
37
37
|
*
|
|
38
|
-
* @param zoomServerError The raw error data from the Zoom API
|
|
39
|
-
* @param responseError The original fetch response error
|
|
40
|
-
* @returns A parsed error, or undefined if the error is unrecognized
|
|
38
|
+
* @param zoomServerError - The raw error data from the Zoom API.
|
|
39
|
+
* @param responseError - The original fetch response error.
|
|
40
|
+
* @returns A parsed error, or undefined if the error is unrecognized.
|
|
41
41
|
*/
|
|
42
42
|
export declare function parseZoomOAuthServerErrorResponseData(zoomServerError: ZoomServerErrorData, responseError: FetchResponseError): FetchRequestFactoryError | import("..").ZoomServerError<ZoomServerErrorData<unknown>> | undefined;
|
|
43
43
|
export declare const handleZoomOAuthErrorFetch: import("..").HandleZoomErrorFetchFactory;
|
|
@@ -17,8 +17,9 @@ export type ZoomOAuthFactory = (config: ZoomOAuthConfig) => ZoomOAuth;
|
|
|
17
17
|
/**
|
|
18
18
|
* Creates a ZoomOAuth instance factory from the given configuration.
|
|
19
19
|
*
|
|
20
|
-
* @param factoryConfig Configuration for the OAuth factory
|
|
21
|
-
* @returns A factory that creates configured ZoomOAuth instances
|
|
20
|
+
* @param factoryConfig - Configuration for the OAuth factory.
|
|
21
|
+
* @returns A factory that creates configured ZoomOAuth instances.
|
|
22
|
+
*
|
|
22
23
|
* @__NO_SIDE_EFFECTS__
|
|
23
24
|
*/
|
|
24
25
|
export declare function zoomOAuthFactory(factoryConfig: ZoomOAuthFactoryConfig): ZoomOAuthFactory;
|
|
@@ -33,10 +34,11 @@ export interface ZoomOAuthZoomAccessTokenFactoryConfig {
|
|
|
33
34
|
readonly accessTokenCache?: Maybe<ZoomAccessTokenCache>;
|
|
34
35
|
}
|
|
35
36
|
/**
|
|
36
|
-
* Creates a ZoomOAuthZoomAccessTokenFactoryConfig
|
|
37
|
+
* Creates a ZoomOAuthZoomAccessTokenFactoryConfig.
|
|
37
38
|
*
|
|
38
39
|
* @param config
|
|
39
40
|
* @returns
|
|
41
|
+
*
|
|
40
42
|
* @__NO_SIDE_EFFECTS__
|
|
41
43
|
*/
|
|
42
44
|
export declare function zoomOAuthZoomAccessTokenFactory(config: ZoomOAuthZoomAccessTokenFactoryConfig): ZoomAccessTokenFactory;
|
|
@@ -11,10 +11,10 @@ export interface GetMeetingInput {
|
|
|
11
11
|
export type GetMeetingResponse = ZoomMeeting;
|
|
12
12
|
export type GetMeetingFunction = (input: GetMeetingInput) => Promise<GetMeetingResponse>;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meeting.
|
|
15
15
|
*
|
|
16
|
-
* @param context The Zoom API context
|
|
17
|
-
* @returns
|
|
16
|
+
* @param context - The Zoom API context.
|
|
17
|
+
* @returns Retrieves a meeting by ID.
|
|
18
18
|
*/
|
|
19
19
|
export declare function getMeeting(context: ZoomContext): GetMeetingFunction;
|
|
20
20
|
export interface ListMeetingsForUserInput extends ZoomPageFilter {
|
|
@@ -23,18 +23,19 @@ export interface ListMeetingsForUserInput extends ZoomPageFilter {
|
|
|
23
23
|
export type ListMeetingsForUserResponse = ZoomPageResult<ZoomMeeting>;
|
|
24
24
|
export type ListMeetingsForUserFunction = (input: ListMeetingsForUserInput) => Promise<ListMeetingsForUserResponse>;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetings.
|
|
27
27
|
*
|
|
28
|
-
* @param context The Zoom API context
|
|
29
|
-
* @returns
|
|
28
|
+
* @param context - The Zoom API context.
|
|
29
|
+
* @returns Lists meetings for a user.
|
|
30
30
|
*/
|
|
31
31
|
export declare function listMeetingsForUser(context: ZoomContext): ListMeetingsForUserFunction;
|
|
32
32
|
export type ListMeetingsForUserPageFactory = FetchPageFactory<ListMeetingsForUserInput, ListMeetingsForUserResponse>;
|
|
33
33
|
/**
|
|
34
34
|
* Creates a page factory for listing meetings for a user.
|
|
35
35
|
*
|
|
36
|
-
* @param context The Zoom API context
|
|
37
|
-
* @returns A page factory for paginated meeting listing
|
|
36
|
+
* @param context - The Zoom API context.
|
|
37
|
+
* @returns A page factory for paginated meeting listing.
|
|
38
|
+
*
|
|
38
39
|
* @__NO_SIDE_EFFECTS__
|
|
39
40
|
*/
|
|
40
41
|
export declare function listMeetingsForUserPageFactory(context: ZoomContext): ListMeetingsForUserPageFactory;
|
|
@@ -132,10 +133,11 @@ export interface CreateMeetingForUserInput {
|
|
|
132
133
|
}
|
|
133
134
|
export type CreateMeetingForUserResponse = ZoomMeeting;
|
|
134
135
|
/**
|
|
135
|
-
*
|
|
136
|
+
* Https://developers.zoom.us/docs/api/meetings/#tag/meetings/POST/users/{userId}/meetings.
|
|
137
|
+
*
|
|
138
|
+
* @param context - The Zoom API context.
|
|
139
|
+
* @returns Creates a meeting for a user.
|
|
136
140
|
*
|
|
137
|
-
* @param context The Zoom API context
|
|
138
|
-
* @returns A function that creates a meeting for a user
|
|
139
141
|
* @__NO_SIDE_EFFECTS__
|
|
140
142
|
*/
|
|
141
143
|
export declare function createMeetingForUser(context: ZoomContext): (input: CreateMeetingForUserInput) => Promise<CreateMeetingForUserResponse>;
|
|
@@ -157,10 +159,10 @@ export interface UpdateMeetingInput {
|
|
|
157
159
|
export type UpdateMeetingResponse = unknown;
|
|
158
160
|
export type UpdateMeetingFunction = (input: UpdateMeetingInput) => Promise<UpdateMeetingResponse>;
|
|
159
161
|
/**
|
|
160
|
-
*
|
|
162
|
+
* Https://developers.zoom.us/docs/api/meetings/#tag/meetings/PUT/meetings/{meetingId}
|
|
161
163
|
*
|
|
162
|
-
* @param context The Zoom API context
|
|
163
|
-
* @returns
|
|
164
|
+
* @param context - The Zoom API context.
|
|
165
|
+
* @returns Updates a meeting.
|
|
164
166
|
*/
|
|
165
167
|
export declare function updateMeeting(context: ZoomContext): UpdateMeetingFunction;
|
|
166
168
|
export interface DeleteMeetingInput extends SilenceZoomErrorConfig {
|
|
@@ -186,10 +188,10 @@ export type DeleteMeetingResponse = unknown;
|
|
|
186
188
|
export type DeleteMeetingFunction = (input: DeleteMeetingInput) => Promise<DeleteMeetingResponse>;
|
|
187
189
|
export declare const DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE = 3001;
|
|
188
190
|
/**
|
|
189
|
-
*
|
|
191
|
+
* Https://developers.zoom.us/docs/api/meetings/#tag/meetings/DELETE/meetings/{meetingId}
|
|
190
192
|
*
|
|
191
|
-
* @param context The Zoom API context
|
|
192
|
-
* @returns
|
|
193
|
+
* @param context - The Zoom API context.
|
|
194
|
+
* @returns Deletes a meeting (silences 3001 "not found" errors by default)
|
|
193
195
|
*/
|
|
194
196
|
export declare function deleteMeeting(context: ZoomContext): DeleteMeetingFunction;
|
|
195
197
|
export interface GetPastMeetingInput {
|
|
@@ -198,10 +200,10 @@ export interface GetPastMeetingInput {
|
|
|
198
200
|
export type GetPastMeetingResponse = PastZoomMeeting;
|
|
199
201
|
export type GetPastMeetingFunction = (input: GetPastMeetingInput) => Promise<GetPastMeetingResponse>;
|
|
200
202
|
/**
|
|
201
|
-
*
|
|
203
|
+
* Https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}
|
|
202
204
|
*
|
|
203
|
-
* @param context The Zoom API context
|
|
204
|
-
* @returns
|
|
205
|
+
* @param context - The Zoom API context.
|
|
206
|
+
* @returns Retrieves a past meeting.
|
|
205
207
|
*/
|
|
206
208
|
export declare function getPastMeeting(context: ZoomContext): GetPastMeetingFunction;
|
|
207
209
|
export interface GetPastMeetingParticipantsInput extends ZoomPageFilter {
|
|
@@ -210,18 +212,19 @@ export interface GetPastMeetingParticipantsInput extends ZoomPageFilter {
|
|
|
210
212
|
export type GetPastMeetingParticipantsResponse = ZoomPageResult<PastZoomMeeting>;
|
|
211
213
|
export type GetPastMeetingParticipantsFunction = (input: GetPastMeetingParticipantsInput) => Promise<GetPastMeetingParticipantsResponse>;
|
|
212
214
|
/**
|
|
213
|
-
*
|
|
215
|
+
* Https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/past_meetings/{meetingId}/participants.
|
|
214
216
|
*
|
|
215
|
-
* @param context The Zoom API context
|
|
216
|
-
* @returns
|
|
217
|
+
* @param context - The Zoom API context.
|
|
218
|
+
* @returns Retrieves participants from a past meeting.
|
|
217
219
|
*/
|
|
218
220
|
export declare function getPastMeetingParticipants(context: ZoomContext): GetPastMeetingParticipantsFunction;
|
|
219
221
|
export type GetPastMeetingParticipantsPageFactory = FetchPageFactory<GetPastMeetingParticipantsInput, GetPastMeetingParticipantsResponse>;
|
|
220
222
|
/**
|
|
221
223
|
* Creates a page factory for listing past meeting participants.
|
|
222
224
|
*
|
|
223
|
-
* @param context The Zoom API context
|
|
224
|
-
* @returns A page factory for paginated participant listing
|
|
225
|
+
* @param context - The Zoom API context.
|
|
226
|
+
* @returns A page factory for paginated participant listing.
|
|
227
|
+
*
|
|
225
228
|
* @__NO_SIDE_EFFECTS__
|
|
226
229
|
*/
|
|
227
230
|
export declare function getPastMeetingParticipantsPageFactory(context: ZoomContext): GetPastMeetingParticipantsPageFactory;
|
|
@@ -9,7 +9,7 @@ export interface GetUserInput {
|
|
|
9
9
|
export type GetUserResponse = ZoomUser;
|
|
10
10
|
export type GetUserFunction = (input: GetUserInput) => Promise<GetUserResponse>;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}
|
|
13
13
|
*
|
|
14
14
|
* @param context
|
|
15
15
|
* @returns
|
|
@@ -22,7 +22,7 @@ export interface ListUsersInput extends ZoomPageFilter {
|
|
|
22
22
|
export type ListUsersResponse = ZoomPageResult<ZoomUser>;
|
|
23
23
|
export type ListUsersFunction = (input?: ListUsersInput) => Promise<ListUsersResponse>;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Https://developers.zoom.us/docs/api/users/#tag/users/GET/users.
|
|
26
26
|
*
|
|
27
27
|
* @param context
|
|
28
28
|
* @returns
|
|
@@ -32,8 +32,9 @@ export type ListUsersPageFactory = FetchPageFactory<ListUsersInput, ListUsersRes
|
|
|
32
32
|
/**
|
|
33
33
|
* Creates a page factory for listing users.
|
|
34
34
|
*
|
|
35
|
-
* @param context The Zoom API context
|
|
36
|
-
* @returns A page factory for paginated user listing
|
|
35
|
+
* @param context - The Zoom API context.
|
|
36
|
+
* @returns A page factory for paginated user listing.
|
|
37
|
+
*
|
|
37
38
|
* @__NO_SIDE_EFFECTS__
|
|
38
39
|
*/
|
|
39
40
|
export declare function listUsersPageFactory(context: ZoomContext): ListUsersPageFactory;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type EmailAddress, type ISO8601DateStringUTCFull, type TimezoneString, type WebsiteUrl } from '@dereekb/util';
|
|
1
|
+
import { type EmailAddress, type ISO8601DateStringUTCFull, type SuggestedString, type TimezoneString, type WebsiteUrl } from '@dereekb/util';
|
|
2
2
|
import { type ZoomClientVersion, type ZoomUserId } from '../zoom.type';
|
|
3
3
|
/**
|
|
4
4
|
* Represents a Zoom user, as returned by the Zoom API.
|
|
@@ -239,7 +239,7 @@ export interface ZoomUserPhoneNumber {
|
|
|
239
239
|
*
|
|
240
240
|
* @example "Mobile"
|
|
241
241
|
*/
|
|
242
|
-
readonly label: 'Mobile' | 'Office' | 'Home' | 'Fax'
|
|
242
|
+
readonly label: SuggestedString<'Mobile' | 'Office' | 'Home' | 'Fax'>;
|
|
243
243
|
/**
|
|
244
244
|
* The user's phone number.
|
|
245
245
|
*
|