@openedx/frontend-base 1.0.0-alpha.13 → 1.0.0-alpha.15

package/dist/tools/webpack/utils/getPublicPath.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getPublicPath;
-function getPublicPath(defaultPath = 'auto') {
+function getPublicPath(defaultPath = '/') {
     return process.env.PUBLIC_PATH ?? defaultPath;
 }

package/dist/types.d.ts

@@ -42,6 +42,8 @@ export interface OptionalSiteConfig {
     externalRoutes: ExternalRoute[];
     externalLinkUrlOverrides: string[];
     runtimeConfigJsonUrl: string | null;
+    commonAppConfig: AppConfig;
+    headerLogoImageUrl: string;
     theme: Theme;
     accessTokenCookieName: string;
     languagePreferenceCookieName: string;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AA8GA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,+CAA2B,CAAA;IAC3B,iCAAa,CAAA;AACf,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B","sourcesContent":["import { FC, ReactElement, ReactNode } from 'react';\nimport { MessageDescriptor } from 'react-intl';\nimport { RouteObject } from 'react-router';\nimport { SlotOperation } from './runtime/slots/types';\n\n// Apps\n\nexport interface ExternalRoute {\n  role: string,\n  url: string,\n}\n\nexport type RoleRouteObject = RouteObject & {\n  handle?: {\n    /**\n     * A route role is used to identify a route that fulfills a particular role in the site.\n     */\n    role?: string,\n  },\n};\n\nexport type AppConfig = Record<string, unknown>;\n\nexport type AppProvider = FC<{ children?: ReactNode }>;\n\nexport interface App {\n  appId: string,\n  messages?: LocalizedMessages,\n  routes?: RoleRouteObject[],\n  providers?: AppProvider[],\n  slots?: SlotOperation[],\n  config?: AppConfig,\n}\n\n// Site Config\n\nexport interface RequiredSiteConfig {\n  siteId: string,\n  siteName: string,\n  baseUrl: string,\n\n  // Backends\n  lmsBaseUrl: string,\n\n  // Frontends\n  loginUrl: string,\n  logoutUrl: string,\n}\n\nexport type LocalizedMessages = Record<string, Record<string, string>>;\n\nexport interface OptionalSiteConfig {\n  // Site environment\n  environment: EnvironmentTypes,\n\n  // Apps, routes, and URLs\n  apps: App[],\n  basename: string,\n  externalRoutes: ExternalRoute[],\n  externalLinkUrlOverrides: string[],\n  runtimeConfigJsonUrl: string | null,\n\n  // Theme\n  theme: Theme,\n\n  // Cookies\n  accessTokenCookieName: string,\n  languagePreferenceCookieName: string,\n  userInfoCookieName: string,\n\n  // Paths\n  csrfTokenApiPath: string,\n  refreshAccessTokenApiPath: string,\n\n  // Logging\n  ignoredErrorRegex: RegExp | null,\n\n  // Analytics\n  segmentKey: string | null,\n}\n\nexport type SiteConfig = RequiredSiteConfig & Partial<OptionalSiteConfig>;\n\nexport interface ThemeVariant {\n  url: string,\n}\n\nexport interface ThemeDefaults {\n  light?: string,\n  dark?: string,\n}\n\nexport type ThemeVariants = Record<string, ThemeVariant>;\n\nexport interface Theme {\n  core?: ThemeVariant,\n  defaults?: ThemeDefaults,\n  variants?: ThemeVariants,\n}\n\nexport interface User {\n  administrator: boolean,\n  email: string,\n  name: string,\n  roles: string[],\n  userId: number,\n  username: string,\n  avatar: string,\n}\n\nexport enum EnvironmentTypes {\n  PRODUCTION = 'production',\n  DEVELOPMENT = 'development',\n  TEST = 'test',\n}\n\n// Menu Items\n\nexport type MenuItemName = string | MessageDescriptor | ReactElement;\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../types.ts"],"names":[],"mappings":"AAgHA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6CAAyB,CAAA;IACzB,+CAA2B,CAAA;IAC3B,iCAAa,CAAA;AACf,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B","sourcesContent":["import { FC, ReactElement, ReactNode } from 'react';\nimport { MessageDescriptor } from 'react-intl';\nimport { RouteObject } from 'react-router';\nimport { SlotOperation } from './runtime/slots/types';\n\n// Apps\n\nexport interface ExternalRoute {\n  role: string,\n  url: string,\n}\n\nexport type RoleRouteObject = RouteObject & {\n  handle?: {\n    /**\n     * A route role is used to identify a route that fulfills a particular role in the site.\n     */\n    role?: string,\n  },\n};\n\nexport type AppConfig = Record<string, unknown>;\n\nexport type AppProvider = FC<{ children?: ReactNode }>;\n\nexport interface App {\n  appId: string,\n  messages?: LocalizedMessages,\n  routes?: RoleRouteObject[],\n  providers?: AppProvider[],\n  slots?: SlotOperation[],\n  config?: AppConfig,\n}\n\n// Site Config\n\nexport interface RequiredSiteConfig {\n  siteId: string,\n  siteName: string,\n  baseUrl: string,\n\n  // Backends\n  lmsBaseUrl: string,\n\n  // Frontends\n  loginUrl: string,\n  logoutUrl: string,\n}\n\nexport type LocalizedMessages = Record<string, Record<string, string>>;\n\nexport interface OptionalSiteConfig {\n  // Site environment\n  environment: EnvironmentTypes,\n\n  // Apps, routes, and URLs\n  apps: App[],\n  basename: string,\n  externalRoutes: ExternalRoute[],\n  externalLinkUrlOverrides: string[],\n  runtimeConfigJsonUrl: string | null,\n  commonAppConfig: AppConfig,\n  headerLogoImageUrl: string,\n\n  // Theme\n  theme: Theme,\n\n  // Cookies\n  accessTokenCookieName: string,\n  languagePreferenceCookieName: string,\n  userInfoCookieName: string,\n\n  // Paths\n  csrfTokenApiPath: string,\n  refreshAccessTokenApiPath: string,\n\n  // Logging\n  ignoredErrorRegex: RegExp | null,\n\n  // Analytics\n  segmentKey: string | null,\n}\n\nexport type SiteConfig = RequiredSiteConfig & Partial<OptionalSiteConfig>;\n\nexport interface ThemeVariant {\n  url: string,\n}\n\nexport interface ThemeDefaults {\n  light?: string,\n  dark?: string,\n}\n\nexport type ThemeVariants = Record<string, ThemeVariant>;\n\nexport interface Theme {\n  core?: ThemeVariant,\n  defaults?: ThemeDefaults,\n  variants?: ThemeVariants,\n}\n\nexport interface User {\n  administrator: boolean,\n  email: string,\n  name: string,\n  roles: string[],\n  userId: number,\n  username: string,\n  avatar: string,\n}\n\nexport enum EnvironmentTypes {\n  PRODUCTION = 'production',\n  DEVELOPMENT = 'development',\n  TEST = 'test',\n}\n\n// Menu Items\n\nexport type MenuItemName = string | MessageDescriptor | ReactElement;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"