@umbraco-cms/backoffice 14.0.0--preview005-5c967edf → 14.0.0--preview005-2c00d16c

package/dist-cms/apps/app/app.element.js

@@ -138,6 +138,7 @@ async function _UmbAppElement_setAuthStatus() {
     // Instruct all requests to use the auth flow to get and use the access_token for all subsequent requests
     OpenAPI.TOKEN = () => __classPrivateFieldGet(this, _UmbAppElement_authContext, "f").getLatestToken();
     OpenAPI.WITH_CREDENTIALS = true;
+    OpenAPI.CREDENTIALS = 'include';
 };
 _UmbAppElement_redirect = function _UmbAppElement_redirect() {
     // If there is a ?code parameter in the url, then we are in the middle of the oauth flow

package/dist-cms/shared/auth/auth.context.d.ts

@@ -1,3 +1,4 @@
+import type { UmbOpenApiConfiguration } from './models/openApiConfiguration.js';
 import type { UmbControllerHostElement } from '../../libs/controller-api/index.js';
 import { UmbBaseController } from '../../libs/class-api/index.js';
 export declare class UmbAuthContext extends UmbBaseController {
@@ -28,7 +29,7 @@ export declare class UmbAuthContext extends UmbBaseController {
      *
      * NB! The user may experience being redirected to the login screen if the token is expired.
      *
-     * @example
+     * @example <caption>Using the latest token</caption>
      * ```js
      *   const token = await authContext.getLatestToken();
      *   const result = await fetch('https://my-api.com', { headers: { Authorization: `Bearer ${token}` } });
@@ -48,4 +49,37 @@ export declare class UmbAuthContext extends UmbBaseController {
      * @memberof UmbAuthContext
      */
     signOut(): Promise<void>;
+    /**
+     * Get the server url to the Management API.
+     * @memberof UmbAuthContext
+     * @example <caption>Using the server url</caption>
+     * ```js
+     * 	const serverUrl = authContext.getServerUrl();
+     * 	OpenAPI.BASE = serverUrl;
+     * ```
+     * @example <caption></caption>
+     * ```js
+     * 	const serverUrl = authContext.getServerUrl();
+     * 	const token = await authContext.getLatestToken();
+     * 	const result = await fetch(`${serverUrl}/umbraco/management/api/v1/my-resource`, { headers: { Authorization: `Bearer ${token}` } });
+     * ```
+     * @returns The server url to the Management API
+     */
+    getServerUrl(): string;
+    /**
+     * Get the default OpenAPI configuration, which is set up to communicate with the Management API.
+     * @remark This is useful if you want to communicate with your own resources generated by the [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) library.
+     * @memberof UmbAuthContext
+     *
+     * @example <caption>Using the default OpenAPI configuration</caption>
+     * ```js
+     *  	const defaultOpenApi = authContext.getOpenApiConfiguration();
+     *  	OpenAPI.BASE = defaultOpenApi.base;
+     * 		OpenAPI.WITH_CREDENTIALS = defaultOpenApi.withCredentials;
+     * 		OpenAPI.CREDENTIALS = defaultOpenApi.credentials;
+     * 		OpenAPI.TOKEN = defaultOpenApi.token;
+     * ```
+     * @returns The default OpenAPI configuration
+     */
+    getOpenApiConfiguration(): UmbOpenApiConfiguration;
 }

package/dist-cms/shared/auth/auth.context.js

@@ -9,11 +9,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _UmbAuthContext_instances, _UmbAuthContext_isAuthorized, _UmbAuthContext_isBypassed, _UmbAuthContext_backofficePath, _UmbAuthContext_authFlow, _UmbAuthContext_getRedirectUrl;
+var _UmbAuthContext_instances, _UmbAuthContext_isAuthorized, _UmbAuthContext_isBypassed, _UmbAuthContext_serverUrl, _UmbAuthContext_backofficePath, _UmbAuthContext_authFlow, _UmbAuthContext_openApi, _UmbAuthContext_getRedirectUrl;
 import { UmbAuthFlow } from './auth-flow.js';
 import { UMB_AUTH_CONTEXT } from './auth.context.token.js';
 import { UmbBaseController } from '../../libs/class-api/index.js';
 import { UmbBooleanState } from '../../libs/observable-api/index.js';
+import { OpenAPI } from '../../external/backend-api/index.js';
 export class UmbAuthContext extends UmbBaseController {
     constructor(host, serverUrl, backofficePath, isBypassed) {
         super(host);
@@ -21,9 +22,12 @@ export class UmbAuthContext extends UmbBaseController {
         _UmbAuthContext_isAuthorized.set(this, new UmbBooleanState(false));
         this.isAuthorized = __classPrivateFieldGet(this, _UmbAuthContext_isAuthorized, "f").asObservable();
         _UmbAuthContext_isBypassed.set(this, false);
+        _UmbAuthContext_serverUrl.set(this, void 0);
         _UmbAuthContext_backofficePath.set(this, void 0);
         _UmbAuthContext_authFlow.set(this, void 0);
+        _UmbAuthContext_openApi.set(this, OpenAPI);
         __classPrivateFieldSet(this, _UmbAuthContext_isBypassed, isBypassed, "f");
+        __classPrivateFieldSet(this, _UmbAuthContext_serverUrl, serverUrl, "f");
         __classPrivateFieldSet(this, _UmbAuthContext_backofficePath, backofficePath, "f");
         __classPrivateFieldSet(this, _UmbAuthContext_authFlow, new UmbAuthFlow(serverUrl, __classPrivateFieldGet(this, _UmbAuthContext_instances, "m", _UmbAuthContext_getRedirectUrl).call(this)), "f");
         this.provideContext(UMB_AUTH_CONTEXT, this);
@@ -68,7 +72,7 @@ export class UmbAuthContext extends UmbBaseController {
      *
      * NB! The user may experience being redirected to the login screen if the token is expired.
      *
-     * @example
+     * @example <caption>Using the latest token</caption>
      * ```js
      *   const token = await authContext.getLatestToken();
      *   const result = await fetch('https://my-api.com', { headers: { Authorization: `Bearer ${token}` } });
@@ -94,7 +98,50 @@ export class UmbAuthContext extends UmbBaseController {
     signOut() {
         return __classPrivateFieldGet(this, _UmbAuthContext_authFlow, "f").signOut();
     }
+    /**
+     * Get the server url to the Management API.
+     * @memberof UmbAuthContext
+     * @example <caption>Using the server url</caption>
+     * ```js
+     * 	const serverUrl = authContext.getServerUrl();
+     * 	OpenAPI.BASE = serverUrl;
+     * ```
+     * @example <caption></caption>
+     * ```js
+     * 	const serverUrl = authContext.getServerUrl();
+     * 	const token = await authContext.getLatestToken();
+     * 	const result = await fetch(`${serverUrl}/umbraco/management/api/v1/my-resource`, { headers: { Authorization: `Bearer ${token}` } });
+     * ```
+     * @returns The server url to the Management API
+     */
+    getServerUrl() {
+        return __classPrivateFieldGet(this, _UmbAuthContext_serverUrl, "f");
+    }
+    /**
+     * Get the default OpenAPI configuration, which is set up to communicate with the Management API.
+     * @remark This is useful if you want to communicate with your own resources generated by the [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) library.
+     * @memberof UmbAuthContext
+     *
+     * @example <caption>Using the default OpenAPI configuration</caption>
+     * ```js
+     *  	const defaultOpenApi = authContext.getOpenApiConfiguration();
+     *  	OpenAPI.BASE = defaultOpenApi.base;
+     * 		OpenAPI.WITH_CREDENTIALS = defaultOpenApi.withCredentials;
+     * 		OpenAPI.CREDENTIALS = defaultOpenApi.credentials;
+     * 		OpenAPI.TOKEN = defaultOpenApi.token;
+     * ```
+     * @returns The default OpenAPI configuration
+     */
+    getOpenApiConfiguration() {
+        return {
+            base: OpenAPI.BASE,
+            version: OpenAPI.VERSION,
+            withCredentials: OpenAPI.WITH_CREDENTIALS,
+            credentials: OpenAPI.CREDENTIALS,
+            token: () => this.getLatestToken(),
+        };
+    }
 }
-_UmbAuthContext_isAuthorized = new WeakMap(), _UmbAuthContext_isBypassed = new WeakMap(), _UmbAuthContext_backofficePath = new WeakMap(), _UmbAuthContext_authFlow = new WeakMap(), _UmbAuthContext_instances = new WeakSet(), _UmbAuthContext_getRedirectUrl = function _UmbAuthContext_getRedirectUrl() {
+_UmbAuthContext_isAuthorized = new WeakMap(), _UmbAuthContext_isBypassed = new WeakMap(), _UmbAuthContext_serverUrl = new WeakMap(), _UmbAuthContext_backofficePath = new WeakMap(), _UmbAuthContext_authFlow = new WeakMap(), _UmbAuthContext_openApi = new WeakMap(), _UmbAuthContext_instances = new WeakSet(), _UmbAuthContext_getRedirectUrl = function _UmbAuthContext_getRedirectUrl() {
     return `${window.location.origin}${__classPrivateFieldGet(this, _UmbAuthContext_backofficePath, "f")}`;
 };

package/dist-cms/shared/auth/index.d.ts

@@ -1,2 +1,3 @@
 export * from './auth.context.js';
 export * from './auth.context.token.js';
+export * from './models/openApiConfiguration.js';

package/dist-cms/shared/auth/index.js

@@ -1,2 +1,3 @@
 export * from './auth.context.js';
 export * from './auth.context.token.js';
+export * from './models/openApiConfiguration.js';

package/dist-cms/shared/auth/models/openApiConfiguration.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Configuration for the OpenAPI (Umbraco) server. This is used to communicate with the Management API.
+ * This is useful if you want to configure your Fetch, Axios or other HTTP client to communicate with the Management API.
+ * If you use the recommended resource generator [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) this can be used to configure the `OpenAPI` object.
+ */
+export interface UmbOpenApiConfiguration {
+    /**
+     * The base URL of the OpenAPI (Umbraco) server.
+     */
+    readonly base: string;
+    /**
+     * The configured version of the Management API to use.
+     */
+    readonly version: string;
+    /**
+     * The `withCredentials` option for the Fetch API.
+     */
+    readonly withCredentials: boolean;
+    /**
+     * The `credentials` option for the Fetch API.
+     */
+    readonly credentials: 'include' | 'omit' | 'same-origin';
+    /**
+     * The token to use for the Authorization header.
+     * @returns A resolver for the token to use for the Authorization header.
+     */
+    readonly token: () => Promise<string>;
+}

package/dist-cms/shared/auth/models/openApiConfiguration.js

@@ -0,0 +1 @@
+export {};