@castlabs/ui 7.9.4 → 7.11.0

package/dist/castlabs-ui.module.d.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+// this contains general non-vue types
+
 declare module '@castlabs/ui/dist/castlabs-ui.module.js' {
   export function clScrollToId (id: string, smooth?: boolean): void
 
@@ -18,9 +20,6 @@ declare module '@castlabs/ui/dist/castlabs-ui.module.js' {
   export function clFormIsValidAsync (id: string): Promise<boolean>
   export function clFormFieldFocusFirstInvalid (id: string): void
   export function clFormAutofocus (id: string): void
-  export function clRefClField (ref: unknown): any
-  export function clRefClFieldGroup (ref: unknown): any
-  export function clRefHTMLElement (ref: unknown): HTMLElement
 
   export function clFormatFilesize (bytes: number): string
   export function clFormatDate (date: Date): string

package/dist/castlabs-ui.module.js

@@ -1,4 +1,4 @@
-/* @castlabs/ui v7.9.4 */
+/* @castlabs/ui v7.11.0 */
 
 /*!
   * Bootstrap v5.3.8 (https://getbootstrap.com/)
@@ -337,6 +337,524 @@ export const CONST = {
   }
 }
 
+// helpers that handle CS data
+
+const ENV = {
+  DEV: 'DEV',
+  TEST: 'TEST',
+  STAG: 'STAG',
+  PROD: 'PROD'
+}
+
+const SERVICE = {
+  CP: 'Content Platform',
+  CP_TAGLINE: 'Access the Content Platform, manage, encode and watermark assets',
+  CP_URN: 'urn:janus:service:76b6e8558263431d9d766779987d6410',
+  CS: 'Castlabs hub',
+  CS_TAGLINE: 'Manage organizations, plans, downloads',
+  CS_URN: 'urn:janus:service:OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO',
+  DT: 'DRMtoday',
+  DT_TAGLINE: 'Cloud DRM & CAS licensing',
+  DT_URN: 'urn:janus:service:79a1092a0be44b1c95a4557b8d3ee2b7',
+  DTO: 'DRMtoday Onboard',
+  DTO_TAGLINE: 'DRMtoday Onboard',
+  DTO_URN: 'urn:janus:service:442f84ee6cc942188cb24486d7208289',
+  DTS: 'DRMtoday Staging',
+  DTS_TAGLINE: 'Cloud DRM & CAS licensing',
+  DTS_URN: 'urn:janus:service:17edeac267d84703ab0ddd7a33d85706',
+  PP: 'PRESTOplay',
+  PP_TAGLINE: 'Cross-platform video players (via Castlabs hub)',
+  PP_URN: 'urn:janus:service:a0682fd65f234a6793c526dc33131bab',
+  PP_URN_ANDROID: 'urn:janus:service:95841e63952149408c71c650c9659fb7',
+  PP_URN_BROWSER: 'urn:janus:service:852e1377df314c1a80003a9f67b98dfe',
+  PP_URN_GSTREAMER: 'urn:janus:service:76b6e8558263431d9d766779987d64c1',
+  PP_URN_IOS: 'urn:janus:service:2187beecaae44a01ac7eb353f5095f0f',
+  PP_URN_REACTNATIVE: 'urn:janus:service:6efecac3ac04477e9b36d3d14e0ae257',
+  PP_URN_WEBRTC: 'urn:janus:service:250402eb2e2d47118422ba4f2334ee54',
+  VTK: 'Video Toolkit',
+  VTK_TAGLINE: 'Cloud encoding, packaging, watermarking',
+  VTK_URN: 'urn:janus:service:a50e21d6a5e246809b636854abfbd34d',
+  WM: 'STARDUSTmark',
+  WM_TAGLINE: 'Video & image forensic watermarking',
+  WM_URN: 'urn:janus:service:76b6e8558263431d9d766779987d64c4'
+}
+
+const ROLE = {
+  CS_READONLY: 'Read-Only',
+  CS_READONLY_URN: 'urn:janus:role:b9d0931a01034fa095aa1a18ec303bac',
+
+  CS_ADMIN: 'Admin',
+  CS_ADMIN_URN: 'urn:janus:role:ab0cc31ad04a4090b41b0e552f7a3742',
+  CS_BILLING: 'Billing',
+  CS_BILLING_URN: 'urn:janus:role:2f4a76d16c9a47609255a253d873135c',
+  CS_REPORTS: 'Reports',
+  CS_REPORTS_URN: 'urn:janus:role:076e6514fe1f4d5abf307dc9fee7bbeb',
+
+  PP_ADMIN: 'PRESTOplay admin',
+  PP_ADMIN_URN: 'urn:janus:role:b79b1a10741f43b2bc0d1302d61b5865',
+  PP_USER: 'PRESTOplay user',
+  PP_USER_URN: 'urn:janus:role:7f2c7c7ee74d46e8936461d57180a1d3',
+
+  DT_MEMBERS: 'Members',
+  DT_MEMBERS_URN: 'urn:janus:role:2e5cfd4579d1485ca7e5f8cc97bdfe32',
+  DT_SUBORGS: 'Sub-organizations',
+  DT_SUBORGS_URN: 'urn:janus:role:2042447e1ae944c5a2bb75c9dd7077f3',
+  DT_CONFIGURATION: 'Configuration',
+  DT_CONFIGURATION_URN: 'urn:janus:role:07ac6d78216e41528d1b04a0ad737bc6',
+  DT_KEYS_DELETE: 'Key delete',
+  DT_KEYS_DELETE_URN: 'urn:janus:role:a79f863667944cca89588f69ea9d61dc',
+  DT_KEYS_INGEST: 'Key ingest',
+  DT_KEYS_INGEST_URN: 'urn:janus:role:08b9f5a98f084dd59d766be7039b504d',
+  DT_ASSETS: 'Assets',
+  DT_ASSETS_URN: 'urn:janus:role:4a2551570d644c08abb2795ccb8474cc',
+  DT_DELIVERIES: 'Deliveries',
+  DT_DELIVERIES_URN: 'urn:janus:role:7e23400fa5b84a38bbeca2ee515e5c9d',
+
+  DTO_DEVICES: 'Devices',
+  DTO_DEVICES_URN: 'urn:janus:role:c4e5556c769f4b23af3e502f9c589511',
+  DTO_KEYBOX: 'Keyboxes',
+  DTO_KEYBOX_URN: 'urn:janus:role:0658721525624ccc8fa612add5152d03',
+  DTO_DOWNLOAD: 'Downloads',
+  DTO_DOWNLOAD_URN: 'urn:janus:role:50905ceedf494b5e8d4379c0edce4b00',
+  DTO_REPORTS: 'Reports',
+  DTO_REPORTS_URN: 'urn:janus:role:50905ceedf494b5e8d4379c0edce4b01',
+  DTO_CONFIGURATION: 'Configuration',
+  DTO_CONFIGURATION_URN: 'urn:janus:role:50905ceedf494b5e8d4379c0edce4b02',
+
+  DTS_MEMBERS: 'Members',
+  DTS_MEMBERS_URN: 'urn:janus:role:36f4f90309294ceaa4f94e56953c1726',
+  DTS_SUBORGS: 'Sub-organizations',
+  DTS_SUBORGS_URN: 'urn:janus:role:471fe9be7e5d46feb6d84dd52e308b71',
+  DTS_CONFIGURATION: 'Configuration',
+  DTS_CONFIGURATION_URN: 'urn:janus:role:ff16e9fd5acc48e8a9acc078d2b72e7d',
+  DTS_KEYS_DELETE: 'Key delete',
+  DTS_KEYS_DELETE_URN: 'urn:janus:role:3f8dc55d3dbb4a4e893ba33ced829642',
+  DTS_KEYS_INGEST: 'Key ingest',
+  DTS_KEYS_INGEST_URN: 'urn:janus:role:471c6826d37f4d3aaa43cb3a3fda63ae',
+  DTS_ASSETS: 'Assets',
+  DTS_ASSETS_URN: 'urn:janus:role:f7c9335c70f14e4bb15d3f30761b8626',
+  DTS_DELIVERIES: 'Deliveries',
+  DTS_DELIVERIES_URN: 'urn:janus:role:e79a8f99a96a45238283b3c049e7374b',
+
+  VTK_ADMIN: 'Video Toolkit admin',
+  VTK_ADMIN_URN: 'urn:janus:role:8ff40a162b834e96a36f7ddbfda475ef',
+  VTK_USER: 'Video Toolkit user',
+  VTK_USER_URN: 'urn:janus:role:33c9c2001ca14dde9c3b310d0748b8b4',
+
+  CP_USER: 'Content Platform user',
+  CP_USER_URN: 'urn:janus:role:33c9c2001ca14dde9c3b310d0748b871',
+
+  WM_DEMO: 'Demo',
+  WM_DEMO_URN: 'urn:janus:role:33c9c2001ca14dde9c3b310d0748b850',
+  WM_EXTRACTION: 'Extraction',
+  WM_EXTRACTION_URN: 'urn:janus:role:33c9c2001ca14dde9c3b310d0748b851'
+}
+
+const STATE = {
+  UNKNOWN: null,
+  ACTIVE: 0,
+  PENDING: 1,
+  DELETED: 2,
+  SUSPENDED: 3
+}
+
+const LICENSE_STATE = {
+  ...STATE,
+  APPROVAL_REQUIRED: 4,
+  APPROVAL_DENIED: 5,
+  APPROVAL_REVOKED: 6
+}
+
+const PLAN = {
+  UNKNOWN: null,
+  TRIAL: 0,
+  STARTER: 1,
+  ENTERPRISE: 2,
+  CUSTOM: 3
+}
+
+const APPS = {
+  CP: {
+    id: 'CP',
+    subtitle: SERVICE.CP_TAGLINE,
+    title: SERVICE.CP,
+    services: [SERVICE.CP_URN],
+    roles: [ROLE.CP_USER_URN],
+    urlManage: (env, oid) =>
+      getEnvUrl(
+        env,
+        `https://platform.content.castlabs.com/#/o/${oid ?? ''}`,
+        `https://platform.content-stag.castlabs.com/#/o/${oid ?? ''}`
+      ),
+    urlPlan: (env, oid) => urlCS(env, oid),
+    sidenav: false
+  },
+
+  CS: {
+    id: 'CS',
+    subtitle: SERVICE.CS_TAGLINE,
+    title: SERVICE.CS,
+    services: [SERVICE.CS_URN],
+    roles: [],
+    urlManage: (env, oid) => urlCS(env, oid),
+    urlPlan: (env, oid) => urlCS(env, oid),
+    sidenav: true
+  },
+
+  DT: {
+    id: 'DT',
+    subtitle: SERVICE.DT_TAGLINE,
+    title: SERVICE.DT,
+    services: [SERVICE.DT_URN],
+    roles: [
+      ROLE.DT_MEMBERS_URN,
+      ROLE.DT_SUBORGS_URN,
+      ROLE.DT_CONFIGURATION_URN,
+      ROLE.DT_KEYS_DELETE_URN,
+      ROLE.DT_KEYS_INGEST_URN,
+      ROLE.DT_ASSETS_URN,
+      ROLE.DT_DELIVERIES_URN
+    ],
+    urlManage: (env, oid) =>
+      getDevTestUrl(
+        env,
+        `https://fe.test.drmtoday.com/dashboard/${oid ? `${oid}/` : ''}index`,
+        `https://fe.drmtoday.com/dashboard/${oid ? `${oid}/` : ''}index`
+      ),
+    urlPlan: (env, oid) => urlCS(env, oid, '/plans/drmtoday'),
+    sidenav: true
+  },
+
+  DTO: {
+    id: 'DTO',
+    subtitle: SERVICE.DTO_TAGLINE,
+    title: SERVICE.DTO,
+    services: [SERVICE.DTO_URN],
+    roles: [
+      ROLE.DTO_DEVICES_URN,
+      ROLE.DTO_KEYBOX_URN,
+      ROLE.DTO_DOWNLOAD_URN,
+      ROLE.DTO_CONFIGURATION_URN,
+      ROLE.DTO_REPORTS_URN
+    ],
+    urlManage: (env, oid) => `https://onboard.castlabs.com/o/${oid ?? ''}/devices`,
+    urlPlan: (env, oid) => urlCS(env, oid),
+    sidenav: false
+  },
+
+  DTS: {
+    id: 'DTS',
+    subtitle: SERVICE.DTS_TAGLINE,
+    title: SERVICE.DTS,
+    services: [SERVICE.DTS_URN],
+    roles: [
+      ROLE.DTS_MEMBERS_URN,
+      ROLE.DTS_SUBORGS_URN,
+      ROLE.DTS_CONFIGURATION_URN,
+      ROLE.DTS_KEYS_DELETE_URN,
+      ROLE.DTS_KEYS_INGEST_URN,
+      ROLE.DTS_ASSETS_URN,
+      ROLE.DTS_DELIVERIES_URN
+    ],
+    urlManage: (env, oid) =>
+      getDevTestUrl(
+        env,
+        `https://fe.test.drmtoday.com/dashboard/${oid ? `${oid}/` : ''}index`,
+        `https://fe.staging.drmtoday.com/dashboard/${oid ? `${oid}/` : ''}index`
+      ),
+    urlPlan: (env, oid) => urlCS(env, oid, '/plans/drmtoday'),
+    sidenav: false
+  },
+
+  PP: {
+    id: 'PP',
+    subtitle: SERVICE.PP_TAGLINE,
+    title: SERVICE.PP,
+    services: [
+      SERVICE.PP_URN,
+      SERVICE.PP_URN_ANDROID,
+      SERVICE.PP_URN_BROWSER,
+      SERVICE.PP_URN_GSTREAMER,
+      SERVICE.PP_URN_IOS,
+      SERVICE.PP_URN_REACTNATIVE,
+      SERVICE.PP_URN_WEBRTC
+    ],
+    roles: [ROLE.PP_USER_URN, ROLE.PP_ADMIN_URN],
+    urlManage: (env, oid) =>
+      getEnvUrl(
+        env,
+        `https://account.castlabs.com/o/${oid}/prestoplay`,
+        `https://account.test.cs.castlabs.com/o/${oid}/prestoplay`
+      ),
+    urlPlan: (env, oid) => urlCS(env, oid, '/plans/prestoplay'),
+    sidenav: true
+  },
+  WM: {
+    id: 'WM',
+    subtitle: SERVICE.WM_TAGLINE,
+    title: SERVICE.WM,
+    services: [SERVICE.WM_URN],
+    roles: [ROLE.WM_DEMO_URN, ROLE.WM_EXTRACTION_URN],
+    urlManage: (env, oid) =>
+      getEnvUrl(
+        env,
+        `https://watermark.castlabs.com/#/o/${oid}`,
+        `https://demo-stag.fwm.castlabs.com/#/o/${oid}`
+      ),
+    urlPlan: (env, oid) => urlCS(env, oid, '/plans/wm'),
+    sidenav: true
+  },
+
+  VTK: {
+    id: 'VTK',
+    subtitle: SERVICE.VTK_TAGLINE,
+    services: [SERVICE.VTK_URN],
+    roles: [ROLE.VTK_USER_URN, ROLE.VTK_ADMIN_URN],
+    title: SERVICE.VTK,
+    urlManage: (env, oid) =>
+      getEnvUrl(env, `https://vtk.castlabs.com/${oid}`, `https://vtks.castlabs.com/${oid}`),
+    urlPlan: (env, oid) => urlCS(env, oid, '/plans/vtk'),
+    sidenav: true
+  }
+}
+
+// ----------------------------------------------------------------------------------------
+
+export const CS = {
+  SERVICE,
+  ROLE,
+  STATE,
+  LICENSE_STATE,
+  PLAN,
+  APPS
+}
+
+// ----------------------------------------------------------------------------------------
+
+function urlCS (env, oid, path) {
+  return getDevTestUrl(
+    env,
+    `https://account.test.cs.castlabs.com/o/${oid ?? ''}${path ?? ''}`,
+    `https://account.castlabs.com/o/${oid ?? ''}${path ?? ''}`
+  )
+}
+
+function getDevTestUrl (env, urlDevTest, urlOther) {
+  return getEnvUrl(env, urlDevTest, urlOther, [ENV.DEV, ENV.TEST])
+}
+
+function getEnvUrl (env, urlEnv, urlOther, envs = [ENV.PROD]) {
+  return envs.includes(env) ? urlEnv : urlOther
+}
+
+// ----------------------------------------------------------------------------------------
+
+function csGetBestOrgLicense (membership, sids) {
+  // sometimes multiple licenes apply to a service (e.g. PP-android, PP-ios, ...)
+  // in that case we choose the license with the highest service level to be used
+  // for sidenav link calulation
+  let best = null
+  for (const sid of sids) {
+    const license = csGetOrgLicense(membership, sid)
+    if (!license) continue
+    if (
+      best === null ||
+      (best.status === CS.LICENSE_STATE.APPROVAL_REQUIRED &&
+        license.status === CS.LICENSE_STATE.ACTIVE) ||
+      (best.plan === CS.PLAN.TRIAL && license.plan !== CS.PLAN.TRIAL)
+    ) {
+      best = license
+    }
+  }
+  return best
+}
+
+function csGetOrgLicense (membership, sid) {
+  for (const license of membership.organization?.licenses ?? []) {
+    if (
+      license.service === sid &&
+      [CS.LICENSE_STATE.ACTIVE, CS.LICENSE_STATE.APPROVAL_REQUIRED].includes(license.status)
+    ) {
+      return license
+    }
+  }
+  return null
+}
+
+function basic (service) {
+  // basic sidenav entry
+  return {
+    id: service.id,
+    title: service.title,
+    subtitle: service.subtitle,
+    url: '#',
+    locked: false,
+    disabled: false,
+    badge: undefined
+  }
+}
+
+function disabled (service) {
+  // sidenav entry in org-unavailable mode
+  return {
+    ...basic(service),
+    locked: true,
+    disabled: true
+  }
+}
+
+function subscribed (service, oid, env) {
+  // sidenav entry in subscribed mode
+  return {
+    ...basic(service),
+    url: service.urlManage(env, oid)
+  }
+}
+
+function trial (service, oid, env) {
+  // sidenav entry in TRIAL mode
+  return {
+    ...subscribed(service, oid, env),
+    badge: 'Trial'
+  }
+}
+
+function subscribe (service, oid, env) {
+  // sidenav entry in SUBSCRIBE mode
+  return {
+    ...basic(service),
+    url: service.urlPlan(env, oid),
+    badge: 'Subscribe',
+    locked: true
+  }
+}
+
+function pending (service, oid, env) {
+  // sidenav entry in PENDING mode
+  return {
+    ...basic(service),
+    url: service.urlPlan(env, oid),
+    badge: 'Pending',
+    locked: true
+  }
+}
+
+function variant (service, license, oid, env, hasRole) {
+  // no license = show subscribe ad
+  if (!license) {
+    // some items are hidden if there is no license
+    if ([APPS.DTS.id].includes(service.id)) return null
+
+    // other items we hint the user to subscribe
+    return subscribe(service, oid, env)
+  }
+
+  // pending license = show pending badge
+  if ([CS.LICENSE_STATE.APPROVAL_REQUIRED].includes(license.status))
+    return pending(service, oid, env)
+
+  // trial license = show trial badge
+  if (license.plan === CS.PLAN.TRIAL) return trial(service, oid, env)
+
+  // any other license and a matching role = manage link
+  if (hasRole) return subscribed(service, oid, env)
+
+  // license but no role = disabled
+  return disabled(service)
+}
+
+function csGetNavVariant (membership, service, oid, env) {
+  const license = csGetBestOrgLicense(membership, service.services)
+  return variant(
+    service,
+    license,
+    oid,
+    env,
+    !!membership.roles.find(r => service.roles.includes(r.role_urn))
+  )
+}
+
+function csParseMembership (membership, oid, env) {
+  const nav = [subscribed(APPS.CS, oid, env)]
+
+  nav.push(csGetNavVariant(membership, APPS.DT, oid, env))
+  const dts = csGetNavVariant(membership, APPS.DTS, oid, env)
+  if (dts) nav.push(dts)
+  nav.push(csGetNavVariant(membership, APPS.PP, oid, env))
+  nav.push(csGetNavVariant(membership, APPS.WM, oid, env))
+  nav.push(csGetNavVariant(membership, APPS.VTK, oid, env))
+
+  return nav
+}
+
+/**
+ * Filters and returns services to be shown in the sidenav based on licenses and user roles for a given org id. The expected
+ * JSON object corresponds to an memberships property from a CS UserInfo object retrieved via
+ * https://auth.castlabs.com/api/v1/userinfo
+ * (@see https://auth.castlabs.com/api/v1/docs#tag/User/operation/janus:UserInfo)
+ *
+ * @param {CsMembership[]} memberships Memberships.
+ * @param {string} oid Organization urn.
+ * @param {string} env Environment to generate links for (PROD, STAG, TEST, DEV).
+ * @returns Array of service navigation objects that the user has access to, in proper order to display in sidenav's service-drawer.
+ */
+export function csGetNav (memberships, oid, env) {
+  for (const membership of memberships) {
+    if (membership.organization?.organization_urn === oid) {
+      return csParseMembership(membership, oid, env)
+    }
+  }
+
+  return [
+    // static nav
+    subscribed(APPS.CS),
+    disabled(APPS.DT),
+    disabled(APPS.PP),
+    disabled(APPS.WM),
+    disabled(APPS.VTK)
+  ]
+}
+
+/**
+ * Filters membership array of CS API to only contain memberships for a given service and role.
+ *
+ * @param {CsMembership[]} memberships Memberships.
+ * @param {string} rid Role urn (optional).
+ * @param {string} sid Service urn (optional).
+ * @returns Array of memberships that match sid and rid. If any id was null, it was considered as 'any'.
+ */
+export function csFilterMemberships (memberships, rid, sid) {
+  let clone = JSON.parse(JSON.stringify(memberships))
+
+  // only keep orgs with licenses for required service
+  if (sid) {
+    clone = clone.filter(membership =>
+      membership.organization.licenses.find(license => license.service === sid)
+    )
+  }
+
+  // only keep orgs with required role
+  if (rid) {
+    clone = clone.filter(membership => membership.roles.find(role => role.role_urn === rid))
+  }
+
+  return clone
+}
+
+/**
+ * Get the link to the current user's account page in CS.
+ *
+ * @param {string} env Environment to generate links for (PROD, STAG, TEST, DEV).
+ * @returns {string} Full url to account page.
+ */
+export function csGetAccountUrl (env) {
+  return getDevTestUrl(
+    env,
+    'https://account.test.cs.castlabs.com/account',
+    'https://account.castlabs.com/account'
+  )
+}
+
 import bootstrap from 'bootstrap/dist/js/bootstrap.bundle.min'
 
 // -----------------------------------------------------------------------------
@@ -1121,19 +1639,3 @@ export function clReload (component, forced = [], optional = [], loading = true)
 export function clSleep (ms) {
   return new Promise(resolve => setTimeout(resolve, ms))
 }
-
-// -----------------------------------------------------------------------------
-// --- $ref typescript cast methods --------------------------------------------
-// -----------------------------------------------------------------------------
-
-export function clRefClField (ref) {
-  return ref
-}
-
-export function clRefClFieldGroup (ref) {
-  return ref
-}
-
-export function clRefHTMLElement (ref) {
-  return ref
-}