@vcd/sdk 15.0.4 → 15.0.6

package/fesm2020/vcd-sdk.mjs

@@ -1,7 +1,7 @@
 import * as i1 from '@angular/common/http';
 import { HttpResponse, HttpClient, HttpHeaders, HttpClientModule } from '@angular/common/http';
 import * as i0 from '@angular/core';
-import { Injectable, Optional, InjectionToken, NgModule } from '@angular/core';
+import { Injectable, InjectionToken, Optional, Inject, NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { tap, finalize, map, catchError, switchMap, retry, flatMap, skipWhile, share, concatMap, filter, withLatestFrom } from 'rxjs/operators';
 import { Observable, throwError, BehaviorSubject, of, ReplaySubject, merge } from 'rxjs';
@@ -322,6 +322,111 @@ class ApiResult {
     }
 }
 
+/**
+ * This is the currently supported - albeit very minimal - public SDK.
+ */
+// Bind straight into the hooks provided by the container.
+if (!window.System || !window.System.registry || !window.System.registry.get) {
+    throw new Error('SystemJS registry not found');
+}
+let containerHooks = window.System.registry.get('@vcd/common');
+if (!containerHooks) {
+    containerHooks = window.System.registry.get('@vcd-ui/common');
+}
+if (!containerHooks) {
+    throw new Error('VCD UI container hooks not present in SystemJS registry');
+}
+/**
+ * Wire in as a string.  Gives the root URL for API access (for example, the load balancer URL
+ * or the single-cell URL).
+ */
+const API_ROOT_URL = containerHooks.API_ROOT_URL;
+/**
+ * Wire in as a string.  Gives the root URL for the legacy Flex application.
+ */
+const FLEX_APP_URL = containerHooks.API_ROOT_URL;
+/**
+ * Wire in as a string.  Gives the current scope of the VCD-UI.  As of current, this will be
+ * either 'tenant' for the tenant portal, or 'service-provider' for the service-provider portal.
+ */
+const SESSION_SCOPE = containerHooks.SESSION_SCOPE;
+/**
+ * Wire in as a string.  Gives the unique name (not the display name) of the current tenant
+ * organization that the VCD-UI is being used for.
+ */
+const SESSION_ORGANIZATION = containerHooks.SESSION_ORGANIZATION;
+/**
+ * Wire in as a string.  Gives the UUID identifier of the current tenant
+ * organization that the VCD-UI is being used for.
+ */
+const SESSION_ORG_ID = containerHooks.SESSION_ORG_ID ? containerHooks.SESSION_ORG_ID : '';
+/**
+ * Wire in as a string.  Gives the full root path for module assets (e.g. images, scripts, text files)
+ *
+ * ATTENTION!
+ * Add || new InjectionToken to workaround the Angular security mechanics which prevent use of injection tokens
+ * which potentially are not defiend. The same fix can be applied for the rest tokens if needed.
+ */
+const EXTENSION_ASSET_URL = containerHooks.EXTENSION_ASSET_URL || new InjectionToken('EXTENSION_ASSET_URL');
+/**
+ * Wire in as a string.  Gives the Angular 2 route that the module is registered under.
+ */
+const EXTENSION_ROUTE = containerHooks.EXTENSION_ROUTE;
+/**
+ * Wire in as a boolean.  True if running under the SDK, false if running in production.
+ */
+const SDK_MODE = containerHooks.SDK_MODE;
+const ExtensionNavRegistrationAction = containerHooks.ExtensionNavRegistrationAction;
+const AuthTokenHolderService = containerHooks.AuthTokenHolderService;
+/**
+ * Every component referenced by an entity action extension point must inherit from this.
+ */
+// tslint:disable-next-line:class-name
+class _EntityActionExtensionComponent {
+}
+const EntityActionExtensionComponent = containerHooks.EntityActionExtensionComponent;
+// tslint:disable-next-line:class-name
+class _WizardExtensionComponent {
+}
+const WizardExtensionComponent = containerHooks.WizardExtensionComponent;
+// tslint:disable-next-line:class-name
+class _WizardExtensionWithValidationComponent extends _WizardExtensionComponent {
+}
+// tslint:disable-next-line:max-line-length
+const WizardExtensionWithValidationComponent = containerHooks.WizardExtensionWithValidationComponent;
+/**
+ * Every component-based Extension Point that is renderd in Cloud Director UI Entity Details
+ * must extend that class to obtain context about the Entity.
+ *
+ * See comments of the methods of the abstract class for more information.
+ */
+// tslint:disable-next-line:class-name
+class _WizardExtensionWithContextComponent extends _WizardExtensionComponent {
+}
+// tslint:disable-next-line:max-line-length
+const WizardExtensionWithContextComponent = containerHooks.WizardExtensionWithContextComponent;
+
+class PluginModule {
+    constructor(appStore) {
+        this.appStore = appStore;
+    }
+    registerExtension(extension) {
+        this.appStore.dispatch(new ExtensionNavRegistrationAction(extension));
+    }
+}
+/**
+ * Config object that is passed on VcdSdkModule init
+ * using .forRoot() method. It can be used to store
+ * configutration properties that are later used by the Services
+ * provided.
+ */
+class VcdSdkConfig {
+}
+/**
+ * Use this token for injecting custom HttpInterceptor implementations inside the HttpClient
+ */
+const VCD_HTTP_INTERCEPTORS = new InjectionToken("VCD_HTTP_INTERCEPTORS");
+
 // tslint:disable:variable-name
 class LoggingInterceptor {
     set enabled(enabled) {
@@ -536,83 +641,35 @@ class VcdHttpClient extends HttpClient {
     /**
      * Create an HttpClient with the logging and header interceptors in the chain.
      * @param httpBackend backend (likely injected from HttpClientModule)
-     * @param hateoasHeaderInterceptor the hateoas header interceptor
      * @param loggingInterceptor the logging interceptor
      * @param requestHeadersInterceptor the request header interceptor
+     * @param responseNormalizationInterceptor
+     * @param customInterceptors
      */
-    constructor(httpBackend, loggingInterceptor, requestHeadersInterceptor, responseNormalizationInterceptor) {
+    constructor(httpBackend, loggingInterceptor, requestHeadersInterceptor, responseNormalizationInterceptor, customInterceptors) {
         const interceptors = [
             loggingInterceptor,
             requestHeadersInterceptor,
-            responseNormalizationInterceptor
+            responseNormalizationInterceptor,
+            ...(customInterceptors ?? []),
         ];
         const chain = interceptors.reduceRight((next, interceptor) => new VcdHttpInterceptorHandler(next, interceptor), httpBackend);
         super(chain);
+        this.customInterceptors = customInterceptors;
         this.loggingInterceptor = loggingInterceptor;
         this.requestHeadersInterceptor = requestHeadersInterceptor;
     }
 }
-VcdHttpClient.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.0", ngImport: i0, type: VcdHttpClient, deps: [{ token: i1.HttpBackend }, { token: LoggingInterceptor }, { token: RequestHeadersInterceptor }, { token: ResponseNormalizationInterceptor }], target: i0.ɵɵFactoryTarget.Injectable });
+VcdHttpClient.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.0", ngImport: i0, type: VcdHttpClient, deps: [{ token: i1.HttpBackend }, { token: LoggingInterceptor }, { token: RequestHeadersInterceptor }, { token: ResponseNormalizationInterceptor }, { token: VCD_HTTP_INTERCEPTORS, optional: true }], target: i0.ɵɵFactoryTarget.Injectable });
 VcdHttpClient.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "15.2.0", ngImport: i0, type: VcdHttpClient });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.0", ngImport: i0, type: VcdHttpClient, decorators: [{
             type: Injectable
-        }], ctorParameters: function () { return [{ type: i1.HttpBackend }, { type: LoggingInterceptor }, { type: RequestHeadersInterceptor }, { type: ResponseNormalizationInterceptor }]; } });
-
-/**
- * This is the currently supported - albeit very minimal - public SDK.
- */
-// Bind straight into the hooks provided by the container.
-if (!window.System || !window.System.registry || !window.System.registry.get) {
-    throw new Error('SystemJS registry not found');
-}
-let containerHooks$1 = window.System.registry.get('@vcd/common');
-if (!containerHooks$1) {
-    containerHooks$1 = window.System.registry.get('@vcd-ui/common');
-}
-if (!containerHooks$1) {
-    throw new Error('VCD UI container hooks not present in SystemJS registry');
-}
-/**
- * Wire in as a string.  Gives the root URL for API access (for example, the load balancer URL
- * or the single-cell URL).
- */
-const API_ROOT_URL$1 = containerHooks$1.API_ROOT_URL;
-/**
- * Wire in as a string.  Gives the root URL for the legacy Flex application.
- */
-const FLEX_APP_URL$1 = containerHooks$1.API_ROOT_URL;
-/**
- * Wire in as a string.  Gives the current scope of the VCD-UI.  As of current, this will be
- * either 'tenant' for the tenant portal, or 'service-provider' for the service-provider portal.
- */
-const SESSION_SCOPE$1 = containerHooks$1.SESSION_SCOPE;
-/**
- * Wire in as a string.  Gives the unique name (not the display name) of the current tenant
- * organization that the VCD-UI is being used for.
- */
-const SESSION_ORGANIZATION$1 = containerHooks$1.SESSION_ORGANIZATION;
-/**
- * Wire in as a string.  Gives the UUID identifier of the current tenant
- * organization that the VCD-UI is being used for.
- */
-const SESSION_ORG_ID$1 = containerHooks$1.SESSION_ORG_ID ? containerHooks$1.SESSION_ORG_ID : '';
-/**
- * Wire in as a string.  Gives the full root path for module assets (e.g. images, scripts, text files)
- *
- * ATTENTION!
- * Add || new InjectionToken to workaround the Angular security mechanics which prevent use of injection tokens
- * which potentially are not defiend. The same fix can be applied for the rest tokens if needed.
- */
-const EXTENSION_ASSET_URL$1 = containerHooks$1.EXTENSION_ASSET_URL || new InjectionToken('EXTENSION_ASSET_URL');
-/**
- * Wire in as a string.  Gives the Angular 2 route that the module is registered under.
- */
-const EXTENSION_ROUTE$1 = containerHooks$1.EXTENSION_ROUTE;
-/**
- * Wire in as a boolean.  True if running under the SDK, false if running in production.
- */
-const SDK_MODE$1 = containerHooks$1.SDK_MODE;
-const AuthTokenHolderService$1 = containerHooks$1.AuthTokenHolderService;
+        }], ctorParameters: function () { return [{ type: i1.HttpBackend }, { type: LoggingInterceptor }, { type: RequestHeadersInterceptor }, { type: ResponseNormalizationInterceptor }, { type: undefined, decorators: [{
+                    type: Optional
+                }, {
+                    type: Inject,
+                    args: [VCD_HTTP_INTERCEPTORS]
+                }] }]; } });
 
 /**
  * Default chunk size is 50MiB.  This is equal to the chunk size the VCD UI uses for library uploads.
@@ -777,106 +834,18 @@ class VcdTransferClient {
     }
 }
 
-/**
- * This is the currently supported - albeit very minimal - public SDK.
- */
-// Bind straight into the hooks provided by the container.
-if (!window.System || !window.System.registry || !window.System.registry.get) {
-    throw new Error('SystemJS registry not found');
-}
-let containerHooks = window.System.registry.get('@vcd/common');
-if (!containerHooks) {
-    containerHooks = window.System.registry.get('@vcd-ui/common');
-}
-if (!containerHooks) {
-    throw new Error('VCD UI container hooks not present in SystemJS registry');
-}
-/**
- * Wire in as a string.  Gives the root URL for API access (for example, the load balancer URL
- * or the single-cell URL).
- */
-const API_ROOT_URL = containerHooks.API_ROOT_URL;
-/**
- * Wire in as a string.  Gives the root URL for the legacy Flex application.
- */
-const FLEX_APP_URL = containerHooks.API_ROOT_URL;
-/**
- * Wire in as a string.  Gives the current scope of the VCD-UI.  As of current, this will be
- * either 'tenant' for the tenant portal, or 'service-provider' for the service-provider portal.
- */
-const SESSION_SCOPE = containerHooks.SESSION_SCOPE;
-/**
- * Wire in as a string.  Gives the unique name (not the display name) of the current tenant
- * organization that the VCD-UI is being used for.
- */
-const SESSION_ORGANIZATION = containerHooks.SESSION_ORGANIZATION;
-/**
- * Wire in as a string.  Gives the UUID identifier of the current tenant
- * organization that the VCD-UI is being used for.
- */
-const SESSION_ORG_ID = containerHooks.SESSION_ORG_ID ? containerHooks.SESSION_ORG_ID : '';
-/**
- * Wire in as a string.  Gives the full root path for module assets (e.g. images, scripts, text files)
- *
- * ATTENTION!
- * Add || new InjectionToken to workaround the Angular security mechanics which prevent use of injection tokens
- * which potentially are not defiend. The same fix can be applied for the rest tokens if needed.
- */
-const EXTENSION_ASSET_URL = containerHooks.EXTENSION_ASSET_URL || new InjectionToken('EXTENSION_ASSET_URL');
-/**
- * Wire in as a string.  Gives the Angular 2 route that the module is registered under.
- */
-const EXTENSION_ROUTE = containerHooks.EXTENSION_ROUTE;
-/**
- * Wire in as a boolean.  True if running under the SDK, false if running in production.
- */
-const SDK_MODE = containerHooks.SDK_MODE;
-const ExtensionNavRegistrationAction = containerHooks.ExtensionNavRegistrationAction;
-const AuthTokenHolderService = containerHooks.AuthTokenHolderService;
-/**
- * Every component referenced by an entity action extension point must inherit from this.
- */
-// tslint:disable-next-line:class-name
-class _EntityActionExtensionComponent {
-}
-const EntityActionExtensionComponent = containerHooks.EntityActionExtensionComponent;
-// tslint:disable-next-line:class-name
-class _WizardExtensionComponent {
-}
-const WizardExtensionComponent = containerHooks.WizardExtensionComponent;
-// tslint:disable-next-line:class-name
-class _WizardExtensionWithValidationComponent extends _WizardExtensionComponent {
-}
-// tslint:disable-next-line:max-line-length
-const WizardExtensionWithValidationComponent = containerHooks.WizardExtensionWithValidationComponent;
-/**
- * Every component-based Extension Point that is renderd in Cloud Director UI Entity Details
- * must extend that class to obtain context about the Entity.
- *
- * See comments of the methods of the abstract class for more information.
- */
-// tslint:disable-next-line:class-name
-class _WizardExtensionWithContextComponent extends _WizardExtensionComponent {
-}
-// tslint:disable-next-line:max-line-length
-const WizardExtensionWithContextComponent = containerHooks.WizardExtensionWithContextComponent;
-
-class PluginModule {
-    constructor(appStore) {
-        this.appStore = appStore;
-    }
-    registerExtension(extension) {
-        this.appStore.dispatch(new ExtensionNavRegistrationAction(extension));
+class ClientError extends Error {
+    constructor(message, type) {
+        super(message);
+        this.message = message;
+        this.type = type;
     }
 }
-/**
- * Config object that is passed on VcdSdkModule init
- * using .forRoot() method. It can be used to store
- * configutration properties that are later used by the Services
- * provided.
- */
-class VcdSdkConfig {
-}
+var ClientErrorType;
+(function (ClientErrorType) {
+    ClientErrorType["HateoasLinkMissing"] = "HateoasLinkMissing";
+    ClientErrorType["TaskLinkMissing"] = "TaskLinkMissing";
+})(ClientErrorType || (ClientErrorType = {}));
 
 const TRANSFER_LINK_REL = 'upload:default';
 const HATEOAS_HEADER = 'Link';
@@ -995,7 +964,7 @@ class VcdApiClient {
          * In this case the old API (/api/session) should not be used at all.
          */
         this._isCloudApiLogin = false;
-        this._baseUrl = this.injector.get(API_ROOT_URL$1);
+        this._baseUrl = this.injector.get(API_ROOT_URL);
         let negotiatedVersion;
         if (this.config?.apiVersion) {
             negotiatedVersion = of(this.config.apiVersion).pipe(map((version) => {
@@ -1007,7 +976,7 @@ class VcdApiClient {
             negotiatedVersion = this.http.get(`${this._baseUrl}/api/versions`).pipe(map(versions => this.negotiateVersion(versions)), tap(version => this.setVersion(version)));
         }
         this._negotiateVersion = negotiatedVersion.pipe(share({ connector: () => new ReplaySubject(1), resetOnError: false, resetOnComplete: false, resetOnRefCountZero: false }));
-        const tokenHolder = this.injector.get(AuthTokenHolderService$1, { token: '' });
+        const tokenHolder = this.injector.get(AuthTokenHolderService, { token: '' });
         const token = tokenHolder.jwt ? `Bearer ${tokenHolder.jwt}` : tokenHolder.token;
         this._getSession = this.setAuthentication(token)
             .pipe(share({ connector: () => new ReplaySubject(1), resetOnError: false, resetOnComplete: false, resetOnRefCountZero: false }));
@@ -1087,10 +1056,10 @@ class VcdApiClient {
         this.http.requestHeadersInterceptor.authentication = authentication;
         return this.http.get(`${this._baseUrl}/api/session`).pipe(tap(session => {
             // automatically set actAs for provider in tenant scope
-            if (session.org === 'System' && this.injector.get(SESSION_SCOPE$1) === 'tenant') {
+            if (session.org === 'System' && this.injector.get(SESSION_SCOPE) === 'tenant') {
                 // Automatic actAs only works in versions >=9.5
                 try {
-                    this.actAs({ id: this.injector.get(SESSION_ORG_ID$1) });
+                    this.actAs({ id: this.injector.get(SESSION_ORG_ID) });
                 }
                 catch (e) {
                     console.warn('No SESSION_ORG_ID set in container. Automatic actAs is disabled.');
@@ -1199,10 +1168,10 @@ class VcdApiClient {
             // Clear previous actAs
             this.actAs(null);
             // automatically set actAs for provider in tenant scope
-            if (session.org && session.org.name === 'System' && this.injector.get(SESSION_SCOPE$1) === 'tenant') {
+            if (session.org && session.org.name === 'System' && this.injector.get(SESSION_SCOPE) === 'tenant') {
                 // Automatic actAs only works in versions >=9.5
                 try {
-                    this.actAs({ id: this.injector.get(SESSION_ORG_ID$1) });
+                    this.actAs({ id: this.injector.get(SESSION_ORG_ID) });
                 }
                 catch (e) {
                     console.warn('No SESSION_ORG_ID set in container. Automatic actAs is disabled.');
@@ -1264,7 +1233,7 @@ class VcdApiClient {
             const link = [...headerLinks, ...links]
                 .find((l) => l.rel === transferRel);
             if (!link) {
-                throw new Error(`Response from ${endpoint} did not contain a transfer link`);
+                throw new ClientError(`Response from ${endpoint} did not contain a transfer link`, ClientErrorType.HateoasLinkMissing);
             }
             return link.href;
         }));
@@ -1293,7 +1262,7 @@ class VcdApiClient {
             const task = Object.assign(new TaskType(), response.body);
             return of(task);
         }
-        return throwError(() => new Error(`An asynchronous request was made to [${httpVerb} ${response.url}], but no task was returned.  The operation may still have been successful.`));
+        return throwError(() => new ClientError(`An asynchronous request was made to [${httpVerb} ${response.url}], but no task was returned.  The operation may still have been successful.`, ClientErrorType.TaskLinkMissing));
     }
     getEntity(entityRefOrUrn) {
         const entityResolver = typeof entityRefOrUrn === 'string' ?
@@ -1310,7 +1279,7 @@ class VcdApiClient {
     removeItem(item, options) {
         const link = this.findLink(item, 'remove', null);
         if (!link) {
-            return throwError(() => new Error(`No 'remove' link for specified resource.`));
+            return throwError(() => new ClientError(`No 'remove' link for specified resource.`, ClientErrorType.HateoasLinkMissing));
         }
         return this.validateRequestContext().pipe(concatMap(() => this.http.delete(link.href, { ...options })));
     }
@@ -1320,7 +1289,7 @@ class VcdApiClient {
     firstPage(result, multisite, options) {
         const link = this.findLink(result, 'firstPage', result.type);
         if (!link) {
-            return throwError(() => new Error(`No 'firstPage' link for specified query.`));
+            return throwError(() => new ClientError(`No 'firstPage' link for specified query.`, ClientErrorType.HateoasLinkMissing));
         }
         return this.getQueryPage(link.href, multisite, options);
     }
@@ -1330,7 +1299,7 @@ class VcdApiClient {
     previousPage(result, multisite, options) {
         const link = this.findLink(result, 'previousPage', result.type);
         if (!link) {
-            return throwError(() => new Error(`No 'previousPage' link for specified query.`));
+            return throwError(() => new ClientError(`No 'previousPage' link for specified query.`, ClientErrorType.HateoasLinkMissing));
         }
         return this.getQueryPage(link.href, multisite, options);
     }
@@ -1340,7 +1309,7 @@ class VcdApiClient {
     nextPage(result, multisite, options) {
         const link = this.findLink(result, 'nextPage', result.type);
         if (!link) {
-            return throwError(() => new Error(`No 'nextPage' link for specified query.`));
+            return throwError(() => new ClientError(`No 'nextPage' link for specified query.`, ClientErrorType.HateoasLinkMissing));
         }
         return this.getQueryPage(link.href, multisite, options);
     }
@@ -1350,7 +1319,7 @@ class VcdApiClient {
     lastPage(result, multisite, options) {
         const link = this.findLink(result, 'lastPage', result.type);
         if (!link) {
-            return throwError(() => new Error(`No 'lastPage' link for specified query.`));
+            return throwError(() => new ClientError(`No 'lastPage' link for specified query.`, ClientErrorType.HateoasLinkMissing));
         }
         return this.getQueryPage(link.href, multisite, options);
     }
@@ -1515,5 +1484,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.0", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { API_ROOT_URL, ApiResult, ApiResultService, AuthTokenHolderService, EXTENSION_ASSET_URL, EXTENSION_ROUTE, EntityActionExtensionComponent, ExtensionNavRegistrationAction, FLEX_APP_URL, Filter, HATEOAS_HEADER, LinkRelType, LoggingInterceptor, MAX_CHUNK_RETRY_COUNT, MAX_CHUNK_SIZE, PluginModule, Query, RequestHeadersInterceptor, ResponseNormalizationInterceptor, SDK_MODE, SESSION_ORGANIZATION, SESSION_ORG_ID, SESSION_SCOPE, TRANSFER_LINK_REL, TransferError, VcdApiClient, VcdHttpClient, VcdSdkConfig, VcdSdkModule, VcdTransferClient, WizardExtensionComponent, WizardExtensionWithContextComponent, WizardExtensionWithValidationComponent, _EntityActionExtensionComponent, _WizardExtensionComponent, _WizardExtensionWithContextComponent, _WizardExtensionWithValidationComponent, parseHeaderHateoasLinks };
+export { API_ROOT_URL, ApiResult, ApiResultService, AuthTokenHolderService, ClientError, ClientErrorType, EXTENSION_ASSET_URL, EXTENSION_ROUTE, EntityActionExtensionComponent, ExtensionNavRegistrationAction, FLEX_APP_URL, Filter, HATEOAS_HEADER, LinkRelType, LoggingInterceptor, MAX_CHUNK_RETRY_COUNT, MAX_CHUNK_SIZE, PluginModule, Query, RequestHeadersInterceptor, ResponseNormalizationInterceptor, SDK_MODE, SESSION_ORGANIZATION, SESSION_ORG_ID, SESSION_SCOPE, TRANSFER_LINK_REL, TransferError, VCD_HTTP_INTERCEPTORS, VcdApiClient, VcdHttpClient, VcdSdkConfig, VcdSdkModule, VcdTransferClient, WizardExtensionComponent, WizardExtensionWithContextComponent, WizardExtensionWithValidationComponent, _EntityActionExtensionComponent, _WizardExtensionComponent, _WizardExtensionWithContextComponent, _WizardExtensionWithValidationComponent, parseHeaderHateoasLinks };
 //# sourceMappingURL=vcd-sdk.mjs.map