Broadlume Common Controls

1.0.1 verified Fri May 01 auth: no javascript

BroadlumeCommon is a set of shared Angular components and utilities (SimpleControlsModule) published as an npm package for internal use by Broadlume. The current stable version is 1.0.1, with no public release cadence or changelog. It includes TypeScript type definitions and requires Angular and its peer dependencies. Unlike general-purpose UI libraries, it is tightly coupled to Broadlume's internal architecture and not recommended for external use.

Common errors

error Cannot find module 'broadlume-common' or its corresponding type declarations. ↓

cause Package installed from git but not built; or TypeScript path resolution fails.

fix

Ensure node_modules/broadlume-common has compiled output; add 'broadlume-common' to tsconfig paths if necessary.

error Module not found: Error: Can't resolve 'broadlume-common' in ... ↓

cause Webpack or bundler cannot locate the package because it is not in node_modules or build failed.

fix

Reinstall via 'npm install git+https://github.com/broadlume/BroadlumeCommonControls.git --save' and run 'npm run build' inside the package.

error TypeError: Cannot read properties of undefined (reading 'ɵmod') ↓

cause Angular module not properly imported or the package version incompatible with Angular version.

fix

Check Angular version compatibility; ensure SimpleControlsModule is imported in @NgModule.

Warnings

gotcha Package is internal and not intended for external use; API may break without notice. ↓

fix Avoid using this package outside Broadlume projects.

gotcha No public registry (npmjs.com); install directly from GitHub repository. ↓

fix Add dependency as 'broadlume-common': 'git+https://github.com/broadlume/BroadlumeCommonControls.git'

gotcha Requires Node.js and npm global tools (e.g., npm run installtools) to build from source. ↓

fix Run 'npm run installtools' in the package directory before building.

Install

npm install broadlume-common

yarn add broadlume-common

pnpm add broadlume-common

Imports

SimpleControlsModule

wrong

const SimpleControlsModule = require('broadlume-common')

correct

import { SimpleControlsModule } from 'broadlume-common'

ESM default; CommonJS require will not work because the package is ESM-only.

SimpleControlsModule (type)

wrong

import { SimpleControlsModule } from 'broadlume-common' in a type-only context

correct

import type { SimpleControlsModule } from 'broadlume-common'

Use type import to avoid bundling runtime code when only used for types.

* (barrel export)

wrong

import BroadlumeCommon from 'broadlume-common' (no default export)

correct

import * as BroadlumeCommon from 'broadlume-common'

The package exports an object-like module; default import is undefined.

Quickstart

Demonstrates importing and using SimpleControlsModule in an Angular module.

import { NgModule } from '@angular/core';
import { SimpleControlsModule } from 'broadlume-common';

@NgModule({
  imports: [SimpleControlsModule]
})
export class AppModule {}