@owlmeans/wled 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OwlMeans Common — Fullstack typescript framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,489 @@
+# @owlmeans/wled
+
+Base types and module declarations for the OwlMeans Common Whitelabeling Subsystem.
+
+## Overview
+
+The `@owlmeans/wled` package provides foundational types, constants, models, and modules for implementing whitelabeling functionality in OwlMeans applications. It serves as the core library for the OwlMeans Common Whitelabeling Subsystem, enabling applications to customize their appearance and branding dynamically.
+
+### Key Features
+
+- **Company Information Management** - Define and manage company branding details
+- **Custom Styling System** - Support for custom colors, fonts, and visual styling
+- **Media Management** - Handle custom brand assets like logos and media
+- **Validation Schemas** - AJV-based schemas for consistent data validation
+- **Route Integration** - Module definitions for whitelabeling API endpoints
+- **Type Safety** - Comprehensive TypeScript interfaces and types
+
+## Core Concepts
+
+### Whitelabeling Types
+
+The package defines several core types for whitelabeling:
+
+- **CompanyInfo** - Basic company information including name, slug, and description
+- **CustomStyles** - Visual styling configuration with colors and fonts
+- **CustomMedia** - Brand assets like logos and media files
+- **CustomUrls** - Custom URL configurations for different environments
+
+### Provider System
+
+The whitelabeling system uses a provider pattern where different types of whitelabeling data (company info, styles, media, DNS) can be requested and provided through a unified interface.
+
+### Validation Integration
+
+All data structures include corresponding AJV validation schemas, ensuring consistent validation across both frontend and backend implementations in fullstack applications.
+
+## Installation
+
+```bash
+npm install @owlmeans/wled
+```
+
+## API Reference
+
+### Types
+
+#### CompanyInfo
+Interface for company information in whitelabeling.
+
+```typescript
+interface CompanyInfo {
+  resource?: string     // Optional resource identifier
+  entityId: string      // Unique entity identifier
+  fullName: string      // Full company name
+  shortName: string     // Abbreviated company name
+  slug: string          // URL-friendly identifier
+  description: string   // Company description
+}
+```
+
+#### CustomStyles
+Interface for custom styling configuration.
+
+```typescript
+interface CustomStyles {
+  resource?: string     // Optional resource identifier
+  entityId: string      // Unique entity identifier
+  font: CustomFont      // Font configuration
+  colors: CustomColors  // Color palette
+}
+```
+
+#### CustomColors
+Interface for custom color configuration.
+
+```typescript
+interface CustomColors {
+  primaryColor: string           // Primary brand color (required)
+  secondaryColor?: string        // Secondary brand color
+  alertColor?: string            // Alert/error color
+  successColor?: string          // Success color
+  primaryBackground?: string     // Primary background color
+  secondaryBackground?: string   // Secondary background color
+  alertBackground?: string       // Alert background color
+  successBackground?: string     // Success background color
+}
+```
+
+#### CustomFont
+Interface for custom font configuration.
+
+```typescript
+interface CustomFont {
+  fontFamily: string    // Font family name
+  basicSize?: number    // Base font size (minimum 8)
+}
+```
+
+#### CustomMedia
+Interface for custom media assets.
+
+```typescript
+interface CustomMedia {
+  brand: CustomBrand    // Brand asset configuration
+}
+```
+
+#### CustomBrand
+Interface for brand asset configuration.
+
+```typescript
+interface CustomBrand {
+  squareLogo?: string   // Square logo URL or path
+  wideLogo?: string     // Wide/horizontal logo URL or path
+}
+```
+
+#### CustomUrls
+Interface for custom URL configuration.
+
+```typescript
+interface CustomUrls {
+  adminUrl: string      // Admin panel URL
+  userUrl: string       // User interface URL
+}
+```
+
+#### ProvideParams
+Interface for provider request parameters.
+
+```typescript
+interface ProvideParams {
+  entity: string        // Entity identifier to provide data for
+}
+```
+
+#### ProvidedWL
+Generic interface for provided whitelabeling data.
+
+```typescript
+type ProvidedWL<T extends {} = {}> = T & {
+  type: string          // Type identifier for the provided data
+  exists: boolean | null // Whether the data exists
+}
+```
+
+### Constants
+
+#### Route Constants
+Constants for whitelabeling routes.
+
+```typescript
+const WL_PROVIDE = 'wl-provide'                    // Route alias
+const WL_PROVIDE_PATH = '/wl/provide/:entity'      // Route path pattern
+```
+
+#### Type Constants
+Constants for whitelabeling data types.
+
+```typescript
+const WL_TYPE_COMPANY_INFO = 'company-info'        // Company information type
+const WL_TYPE_STYLES = 'styles'                    // Styling configuration type
+const WL_TYPE_MEDIA = 'media'                      // Media assets type
+const WL_TYPE_DNS = 'dns'                          // DNS configuration type
+```
+
+### Validation Schemas
+
+The package includes AJV validation schemas for all data structures, ensuring consistent validation across fullstack applications.
+
+#### CompanyInfoSchema
+AJV schema for validating CompanyInfo data.
+
+```typescript
+const CompanyInfoSchema: JSONSchemaType<CompanyInfo> = {
+  type: 'object',
+  properties: {
+    resource: { type: 'string', minLength: 0, nullable: true },
+    entityId: { type: 'string', minLength: 1 },
+    fullName: { type: 'string', minLength: 1, maxLength: 128 },
+    shortName: { type: 'string', minLength: 0, maxLength: 32 },
+    slug: { type: 'string', minLength: 0 },
+    description: { type: 'string', minLength: 0, maxLength: 512 }
+  },
+  required: ['entityId', 'fullName', 'shortName', 'slug', 'description'],
+  additionalProperties: false
+}
+```
+
+#### CustomStylesSchema
+AJV schema for validating CustomStyles data.
+
+```typescript
+const CustomStylesSchema: JSONSchemaType<CustomStyles> = {
+  type: 'object',
+  properties: {
+    resource: { type: 'string', minLength: 0, nullable: true },
+    entityId: { type: 'string', minLength: 1 },
+    font: CustomFontSchema,
+    colors: CustomColorsSchema
+  },
+  required: ['entityId', 'font', 'colors'],
+  additionalProperties: false
+}
+```
+
+#### CustomColorsSchema
+AJV schema for validating CustomColors data.
+
+```typescript
+const CustomColorsSchema: JSONSchemaType<CustomColors> = {
+  type: 'object',
+  properties: {
+    primaryColor: { type: 'string', pattern: '^#(\\d|[a-fA-F]){3,8}$' },
+    secondaryColor: { type: 'string', pattern: '^#(\\d|[a-fA-F]){3,8}$', nullable: true },
+    // ... other color properties with hex color validation
+  },
+  required: ['primaryColor'],
+  additionalProperties: false
+}
+```
+
+#### CustomFontSchema
+AJV schema for validating CustomFont data.
+
+```typescript
+const CustomFontSchema: JSONSchemaType<CustomFont> = {
+  type: 'object',
+  properties: {
+    fontFamily: { type: 'string', minLength: 0, maxLength: 128 },
+    basicSize: { type: 'number', minimum: 8, nullable: true }
+  },
+  required: ['fontFamily'],
+  additionalProperties: false
+}
+```
+
+#### ProvideParamsSchema
+AJV schema for validating ProvideParams data.
+
+```typescript
+const ProvideParamsSchema: JSONSchemaType<ProvideParams> = {
+  type: 'object',
+  properties: {
+    entity: { type: 'string', minLength: 1 }
+  },
+  required: ['entity'],
+  additionalProperties: false
+}
+```
+
+### Modules
+
+#### Whitelabeling Provider Module
+Pre-configured module for handling whitelabeling data provision.
+
+```typescript
+import { modules } from '@owlmeans/wled'
+
+// The package exports a pre-configured module array
+const modules = [
+  module(
+    route(WL_PROVIDE, WL_PROVIDE_PATH, backend()),
+    filter(params(ProvideParamsSchema))
+  )
+]
+```
+
+This module provides:
+- Route configuration for `/wl/provide/:entity` endpoint
+- Parameter validation using the ProvideParamsSchema
+- Backend route configuration
+
+## Usage Examples
+
+### Basic Company Information
+
+```typescript
+import { CompanyInfo, WL_TYPE_COMPANY_INFO } from '@owlmeans/wled'
+
+// Create company information
+const companyInfo: CompanyInfo = {
+  entityId: 'company-123',
+  fullName: 'Example Corporation',
+  shortName: 'ExampleCorp',
+  slug: 'example-corp',
+  description: 'A leading technology company'
+}
+
+// Use with provider system
+const providedCompanyInfo: ProvidedWL<CompanyInfo> = {
+  ...companyInfo,
+  type: WL_TYPE_COMPANY_INFO,
+  exists: true
+}
+```
+
+### Custom Styling Configuration
+
+```typescript
+import { CustomStyles, CustomColors, CustomFont, WL_TYPE_STYLES } from '@owlmeans/wled'
+
+// Define custom colors
+const customColors: CustomColors = {
+  primaryColor: '#007bff',
+  secondaryColor: '#6c757d',
+  alertColor: '#dc3545',
+  successColor: '#28a745',
+  primaryBackground: '#ffffff',
+  secondaryBackground: '#f8f9fa'
+}
+
+// Define custom font
+const customFont: CustomFont = {
+  fontFamily: 'Inter, sans-serif',
+  basicSize: 14
+}
+
+// Create custom styles
+const customStyles: CustomStyles = {
+  entityId: 'company-123',
+  font: customFont,
+  colors: customColors
+}
+
+// Use with provider system
+const providedStyles: ProvidedWL<CustomStyles> = {
+  ...customStyles,
+  type: WL_TYPE_STYLES,
+  exists: true
+}
+```
+
+### Media Assets Configuration
+
+```typescript
+import { CustomMedia, CustomBrand, WL_TYPE_MEDIA } from '@owlmeans/wled'
+
+// Define brand assets
+const customBrand: CustomBrand = {
+  squareLogo: '/assets/logo-square.png',
+  wideLogo: '/assets/logo-wide.png'
+}
+
+// Create media configuration
+const customMedia: CustomMedia = {
+  brand: customBrand
+}
+
+// Use with provider system
+const providedMedia: ProvidedWL<CustomMedia> = {
+  ...customMedia,
+  type: WL_TYPE_MEDIA,
+  exists: true
+}
+```
+
+### Module Integration
+
+```typescript
+import { modules } from '@owlmeans/wled'
+import { context } from '@owlmeans/context'
+
+// Add whitelabeling modules to your application context
+context.modules.push(...modules)
+
+// The modules will handle requests to /wl/provide/:entity
+// with proper parameter validation
+```
+
+## Integration Patterns
+
+### Backend Integration
+
+```typescript
+import { modules, ProvideParams, CompanyInfo, WL_TYPE_COMPANY_INFO } from '@owlmeans/wled'
+
+// Register the whitelabeling provider module
+app.use(modules)
+
+// Implement handler for whitelabeling data provision
+const handleProvideWL = async (params: ProvideParams) => {
+  const { entity } = params
+  
+  // Fetch company information for the entity
+  const companyInfo = await getCompanyInfo(entity)
+  
+  if (companyInfo) {
+    return {
+      ...companyInfo,
+      type: WL_TYPE_COMPANY_INFO,
+      exists: true
+    }
+  }
+  
+  return {
+    type: WL_TYPE_COMPANY_INFO,
+    exists: false
+  }
+}
+```
+
+### Frontend Integration
+
+```typescript
+import { ProvideParams, ProvidedWL, CompanyInfo, WL_TYPE_COMPANY_INFO } from '@owlmeans/wled'
+
+// Fetch whitelabeling data from the provider endpoint
+const fetchWhitelabelingData = async (entity: string): Promise<ProvidedWL<CompanyInfo>> => {
+  const response = await fetch(`/wl/provide/${entity}`)
+  return response.json()
+}
+
+// Use in React component
+const WhitelabeledHeader = ({ entity }: { entity: string }) => {
+  const [companyInfo, setCompanyInfo] = useState<ProvidedWL<CompanyInfo> | null>(null)
+  
+  useEffect(() => {
+    fetchWhitelabelingData(entity).then(setCompanyInfo)
+  }, [entity])
+  
+  if (!companyInfo?.exists) {
+    return <DefaultHeader />
+  }
+  
+  return (
+    <header>
+      <h1>{companyInfo.fullName}</h1>
+      <p>{companyInfo.description}</p>
+    </header>
+  )
+}
+```
+
+### Multi-Type Provider Implementation
+
+```typescript
+import { 
+  ProvideParams, 
+  ProvidedWL, 
+  CompanyInfo, 
+  CustomStyles, 
+  CustomMedia,
+  WL_TYPE_COMPANY_INFO,
+  WL_TYPE_STYLES,
+  WL_TYPE_MEDIA
+} from '@owlmeans/wled'
+
+// Generic provider that can handle different types
+const provideWhitelabelingData = async (
+  entity: string, 
+  type: string
+): Promise<ProvidedWL<any>> => {
+  switch (type) {
+    case WL_TYPE_COMPANY_INFO:
+      return await provideCompanyInfo(entity)
+    case WL_TYPE_STYLES:
+      return await provideCustomStyles(entity)
+    case WL_TYPE_MEDIA:
+      return await provideCustomMedia(entity)
+    default:
+      return { type, exists: false }
+  }
+}
+```
+
+## Best Practices
+
+1. **Consistent Validation** - Always use the provided AJV schemas to validate data on both frontend and backend
+2. **Type Safety** - Leverage TypeScript interfaces to ensure type safety throughout your application
+3. **Resource Management** - Use the optional `resource` field to track data sources and manage resources
+4. **Error Handling** - Always check the `exists` property in `ProvidedWL` responses before using the data
+5. **Hex Color Validation** - The color schemas enforce hex color format with proper validation patterns
+6. **Font Size Constraints** - Ensure font sizes meet the minimum requirement (8) when specified
+7. **Entity Identification** - Use consistent entity identifiers across all whitelabeling data types
+
+## Dependencies
+
+This package depends on:
+- `@owlmeans/auth` - For authentication and entity validation schemas
+- `@owlmeans/module` - For module creation and filtering
+- `@owlmeans/route` - For route configuration
+- `ajv` - For JSON schema validation (peer dependency)
+
+## Related Packages
+
+- `@owlmeans/client-wl` - Client-side whitelabeling implementations
+- `@owlmeans/server-wl` - Server-side whitelabeling implementations
+- `@owlmeans/web-wl` - Web-specific whitelabeling components

package/build/consts.d.ts

@@ -0,0 +1,7 @@
+export declare const WL_PROVIDE = "wl-provide";
+export declare const WL_PROVIDE_PATH = "/wl/provide/:entity";
+export declare const WL_TYPE_COMPANY_INFO = "company-info";
+export declare const WL_TYPE_STYLES = "styles";
+export declare const WL_TYPE_MEDIA = "media";
+export declare const WL_TYPE_DNS = "dns";
+//# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,eAAe,CAAA;AAEtC,eAAO,MAAM,eAAe,wBAAwB,CAAA;AAEpD,eAAO,MAAM,oBAAoB,iBAAiB,CAAA;AAElD,eAAO,MAAM,cAAc,WAAW,CAAA;AAEtC,eAAO,MAAM,aAAa,UAAU,CAAA;AAEpC,eAAO,MAAM,WAAW,QAAQ,CAAA"}

package/build/consts.js

@@ -0,0 +1,7 @@
+export const WL_PROVIDE = 'wl-provide';
+export const WL_PROVIDE_PATH = '/wl/provide/:entity';
+export const WL_TYPE_COMPANY_INFO = 'company-info';
+export const WL_TYPE_STYLES = 'styles';
+export const WL_TYPE_MEDIA = 'media';
+export const WL_TYPE_DNS = 'dns';
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,UAAU,GAAG,YAAY,CAAA;AAEtC,MAAM,CAAC,MAAM,eAAe,GAAG,qBAAqB,CAAA;AAEpD,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAAA;AAElD,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAA;AAEtC,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAA;AAEpC,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAA"}

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export type * from './types.js';
+export * from './model/index.js';
+export * from './consts.js';
+export * from './modules.js';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,mBAAmB,YAAY,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/build/index.js

@@ -0,0 +1,4 @@
+export * from './model/index.js';
+export * from './consts.js';
+export * from './modules.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,cAAc,kBAAkB,CAAA;AAChC,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/build/model/company.d.ts

@@ -0,0 +1,4 @@
+import type { JSONSchemaType } from 'ajv';
+import type { CompanyInfo } from '../types.js';
+export declare const CompanyInfoSchema: JSONSchemaType<CompanyInfo>;
+//# sourceMappingURL=company.d.ts.map

package/build/model/company.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../src/model/company.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAG9C,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAAC,WAAW,CAYzD,CAAA"}

package/build/model/company.js

@@ -0,0 +1,15 @@
+import { EntityValueSchema, ResourceValueSchema } from '@owlmeans/auth';
+export const CompanyInfoSchema = {
+    type: 'object',
+    properties: {
+        resource: { ...ResourceValueSchema, minLength: 0, nullable: true },
+        entityId: { ...EntityValueSchema },
+        fullName: { type: 'string', minLength: 1, maxLength: 128 },
+        shortName: { type: 'string', minLength: 0, maxLength: 32 },
+        slug: { ...EntityValueSchema, minLength: 0 },
+        description: { type: 'string', minLength: 0, maxLength: 512 }
+    },
+    required: ['entityId', 'fullName', 'shortName', 'slug', 'description'],
+    additionalProperties: false,
+};
+//# sourceMappingURL=company.js.map

package/build/model/company.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.js","sourceRoot":"","sources":["../../src/model/company.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEvE,MAAM,CAAC,MAAM,iBAAiB,GAAgC;IAC5D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,GAAG,mBAAmB,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE;QAClE,QAAQ,EAAE,EAAE,GAAG,iBAAiB,EAAE;QAClC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;QAC1D,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;QAC1D,IAAI,EAAE,EAAE,GAAG,iBAAiB,EAAE,SAAS,EAAE,CAAC,EAAE;QAC5C,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;KAC9D;IACD,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC;IACtE,oBAAoB,EAAE,KAAK;CAC5B,CAAA"}

package/build/model/index.d.ts

@@ -0,0 +1,4 @@
+export * from './company.js';
+export * from './styles.js';
+export * from './provider.js';
+//# sourceMappingURL=index.d.ts.map

package/build/model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

package/build/model/index.js

@@ -0,0 +1,4 @@
+export * from './company.js';
+export * from './styles.js';
+export * from './provider.js';
+//# sourceMappingURL=index.js.map

package/build/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

package/build/model/provider.d.ts

@@ -0,0 +1,4 @@
+import type { JSONSchemaType } from 'ajv';
+import type { ProvideParams } from '../types.js';
+export declare const ProvideParamsSchema: JSONSchemaType<ProvideParams>;
+//# sourceMappingURL=provider.d.ts.map

package/build/model/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/model/provider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD,eAAO,MAAM,mBAAmB,EAAE,cAAc,CAAC,aAAa,CAO7D,CAAA"}

package/build/model/provider.js

@@ -0,0 +1,10 @@
+import { EntityValueSchema } from '@owlmeans/auth';
+export const ProvideParamsSchema = {
+    type: 'object',
+    properties: {
+        entity: { ...EntityValueSchema }
+    },
+    required: ['entity'],
+    additionalProperties: false,
+};
+//# sourceMappingURL=provider.js.map

package/build/model/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/model/provider.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD,MAAM,CAAC,MAAM,mBAAmB,GAAkC;IAChE,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,GAAG,iBAAiB,EAAE;KACjC;IACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,oBAAoB,EAAE,KAAK;CAC5B,CAAA"}

package/build/model/styles.d.ts

@@ -0,0 +1,7 @@
+import type { JSONSchemaType } from 'ajv';
+import type { CustomStyles, CustomColors, CustomFont } from '../types.js';
+export declare const CustomFontSchema: JSONSchemaType<CustomFont>;
+export declare const ColorSchema: JSONSchemaType<string>;
+export declare const CustomColorsSchema: JSONSchemaType<CustomColors>;
+export declare const CustomStylesSchema: JSONSchemaType<CustomStyles>;
+//# sourceMappingURL=styles.d.ts.map

package/build/model/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/model/styles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGzE,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAQvD,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,cAAc,CAAC,MAAM,CAK9C,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,YAAY,CAc3D,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,YAAY,CAU3D,CAAA"}

package/build/model/styles.js

@@ -0,0 +1,43 @@
+import { EntityValueSchema, ResourceValueSchema } from '@owlmeans/auth';
+export const CustomFontSchema = {
+    type: 'object',
+    properties: {
+        fontFamily: { type: 'string', minLength: 0, maxLength: 128 },
+        basicSize: { type: 'number', minimum: 8, nullable: true, }
+    },
+    required: ['fontFamily'],
+    additionalProperties: false,
+};
+export const ColorSchema = {
+    type: 'string',
+    pattern: '^#(\\d|[a-fA-F]){3,8}$',
+    minLength: 4,
+    maxLength: 9
+};
+export const CustomColorsSchema = {
+    type: 'object',
+    properties: {
+        primaryColor: ColorSchema,
+        secondaryColor: { ...ColorSchema, nullable: true },
+        alertColor: { ...ColorSchema, nullable: true },
+        successColor: { ...ColorSchema, nullable: true },
+        primaryBackground: { ...ColorSchema, nullable: true },
+        secondaryBackground: { ...ColorSchema, nullable: true },
+        alertBackground: { ...ColorSchema, nullable: true },
+        successBackground: { ...ColorSchema, nullable: true },
+    },
+    required: ['primaryColor'],
+    additionalProperties: false,
+};
+export const CustomStylesSchema = {
+    type: 'object',
+    properties: {
+        resource: { ...ResourceValueSchema, minLength: 0, nullable: true },
+        entityId: { ...EntityValueSchema },
+        font: CustomFontSchema,
+        colors: CustomColorsSchema
+    },
+    required: ['font', 'colors'],
+    additionalProperties: false,
+};
+//# sourceMappingURL=styles.js.map

package/build/model/styles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.js","sourceRoot":"","sources":["../../src/model/styles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEvE,MAAM,CAAC,MAAM,gBAAgB,GAA+B;IAC1D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;QAC5D,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,GAAG;KAC3D;IACD,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,oBAAoB,EAAE,KAAK;CAC5B,CAAA;AAED,MAAM,CAAC,MAAM,WAAW,GAA2B;IACjD,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,wBAAwB;IACjC,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,CAAC;CACb,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAiC;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,YAAY,EAAE,WAAW;QACzB,cAAc,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QAClD,UAAU,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC9C,YAAY,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,iBAAiB,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QACrD,mBAAmB,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvD,eAAe,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnD,iBAAiB,EAAE,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtD;IACD,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,oBAAoB,EAAE,KAAK;CAC5B,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAiC;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,QAAQ,EAAE,EAAE,GAAG,mBAAmB,EAAE,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE;QAClE,QAAQ,EAAE,EAAE,GAAG,iBAAiB,EAAE;QAClC,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE,kBAAkB;KAC3B;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,oBAAoB,EAAE,KAAK;CAC5B,CAAA"}

package/build/modules.d.ts

@@ -0,0 +1,2 @@
+export declare const modules: import("@owlmeans/module").CommonModule[];
+//# sourceMappingURL=modules.d.ts.map

package/build/modules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.d.ts","sourceRoot":"","sources":["../src/modules.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,OAAO,2CAKnB,CAAA"}

package/build/modules.js

@@ -0,0 +1,8 @@
+import { filter, module, params } from '@owlmeans/module';
+import { route, backend } from '@owlmeans/route';
+import { WL_PROVIDE, WL_PROVIDE_PATH } from './consts.js';
+import { ProvideParamsSchema } from './model/provider.js';
+export const modules = [
+    module(route(WL_PROVIDE, WL_PROVIDE_PATH, backend()), filter(params(ProvideParamsSchema)))
+];
+//# sourceMappingURL=modules.js.map

package/build/modules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modules.js","sourceRoot":"","sources":["../src/modules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAEzD,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,MAAM,CACJ,KAAK,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,EAC7C,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,CACpC;CACF,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,47 @@
+export interface CompanyInfo {
+    resource?: string;
+    entityId: string;
+    fullName: string;
+    shortName: string;
+    slug: string;
+    description: string;
+}
+export interface CustomStyles {
+    resource?: string;
+    entityId: string;
+    font: CustomFont;
+    colors: CustomColors;
+}
+export interface CustomColors {
+    primaryColor: string;
+    secondaryColor?: string;
+    alertColor?: string;
+    successColor?: string;
+    primaryBackground?: string;
+    secondaryBackground?: string;
+    alertBackground?: string;
+    successBackground?: string;
+}
+export interface CustomFont {
+    fontFamily: string;
+    basicSize?: number;
+}
+export interface CustomMedia {
+    brand: CustomBrand;
+}
+export interface CustomBrand {
+    squareLogo?: string;
+    wideLogo?: string;
+}
+export interface ProvideParams {
+    entity: string;
+}
+export interface CustomUrls {
+    adminUrl: string;
+    userUrl: string;
+}
+export type ProvidedWL<T extends {} = {}> = T & {
+    type: string;
+    exists: boolean | null;
+};
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,YAAY,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;CACf;AAEC,MAAM,WAAW,UAAU;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG;IAC9C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;CACvB,CAAA"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@owlmeans/wled",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 396 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "ajv": "*"
+  },
+  "dependencies": {
+    "@owlmeans/auth": "^0.1.0",
+    "@owlmeans/module": "^0.1.0",
+    "@owlmeans/route": "^0.1.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.7",
+    "npm-check": "^6.0.1",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,12 @@
+
+export const WL_PROVIDE = 'wl-provide'
+
+export const WL_PROVIDE_PATH = '/wl/provide/:entity'
+
+export const WL_TYPE_COMPANY_INFO = 'company-info'
+
+export const WL_TYPE_STYLES = 'styles'
+
+export const WL_TYPE_MEDIA = 'media'
+
+export const WL_TYPE_DNS = 'dns'

package/src/index.ts

@@ -0,0 +1,5 @@
+
+export type * from './types.js'
+export * from './model/index.js'
+export * from './consts.js'
+export * from './modules.js'

package/src/model/company.ts

@@ -0,0 +1,17 @@
+import type { JSONSchemaType } from 'ajv'
+import type { CompanyInfo } from '../types.js'
+import { EntityValueSchema, ResourceValueSchema } from '@owlmeans/auth'
+
+export const CompanyInfoSchema: JSONSchemaType<CompanyInfo> = {
+  type: 'object',
+  properties: {
+    resource: { ...ResourceValueSchema, minLength: 0, nullable: true },
+    entityId: { ...EntityValueSchema },
+    fullName: { type: 'string', minLength: 1, maxLength: 128 },
+    shortName: { type: 'string', minLength: 0, maxLength: 32 },
+    slug: { ...EntityValueSchema, minLength: 0 },
+    description: { type: 'string', minLength: 0, maxLength: 512 }
+  },
+  required: ['entityId', 'fullName', 'shortName', 'slug', 'description'],
+  additionalProperties: false,
+}

package/src/model/index.ts

@@ -0,0 +1,4 @@
+
+export * from './company.js'
+export * from './styles.js'
+export * from './provider.js'

package/src/model/provider.ts

@@ -0,0 +1,13 @@
+
+import type { JSONSchemaType } from 'ajv'
+import type { ProvideParams } from '../types.js'
+import { EntityValueSchema } from '@owlmeans/auth'
+
+export const ProvideParamsSchema: JSONSchemaType<ProvideParams> = {
+  type: 'object',
+  properties: {
+    entity: { ...EntityValueSchema }
+  },
+  required: ['entity'],
+  additionalProperties: false,
+}

package/src/model/styles.ts

@@ -0,0 +1,49 @@
+import type { JSONSchemaType } from 'ajv'
+import type { CustomStyles, CustomColors, CustomFont } from '../types.js'
+import { EntityValueSchema, ResourceValueSchema } from '@owlmeans/auth'
+
+export const CustomFontSchema: JSONSchemaType<CustomFont> = {
+  type: 'object',
+  properties: {
+    fontFamily: { type: 'string', minLength: 0, maxLength: 128 },
+    basicSize: { type: 'number', minimum: 8, nullable: true, }
+  },
+  required: ['fontFamily'],
+  additionalProperties: false,
+}
+
+export const ColorSchema: JSONSchemaType<string> = {
+  type: 'string',
+  pattern: '^#(\\d|[a-fA-F]){3,8}$',
+  minLength: 4,
+  maxLength: 9
+}
+
+export const CustomColorsSchema: JSONSchemaType<CustomColors> = {
+  type: 'object',
+  properties: {
+    primaryColor: ColorSchema,
+    secondaryColor: { ...ColorSchema, nullable: true },
+    alertColor: { ...ColorSchema, nullable: true },
+    successColor: { ...ColorSchema, nullable: true },
+    primaryBackground: { ...ColorSchema, nullable: true },
+    secondaryBackground: { ...ColorSchema, nullable: true },
+    alertBackground: { ...ColorSchema, nullable: true },
+    successBackground: { ...ColorSchema, nullable: true },
+  },
+  required: ['primaryColor'],
+  additionalProperties: false,
+}
+
+export const CustomStylesSchema: JSONSchemaType<CustomStyles> = {
+  type: 'object',
+  properties: {
+    resource: { ...ResourceValueSchema, minLength: 0, nullable: true },
+    entityId: { ...EntityValueSchema },
+    font: CustomFontSchema,
+    colors: CustomColorsSchema
+  },
+  required: ['font', 'colors'],
+  additionalProperties: false,
+}
+

package/src/modules.ts

@@ -0,0 +1,11 @@
+import { filter, module, params } from '@owlmeans/module'
+import { route, backend } from '@owlmeans/route'
+import { WL_PROVIDE, WL_PROVIDE_PATH } from './consts.js'
+import { ProvideParamsSchema } from './model/provider.js'
+
+export const modules = [
+  module(
+    route(WL_PROVIDE, WL_PROVIDE_PATH, backend()),
+    filter(params(ProvideParamsSchema))
+  )
+]

package/src/types.ts

@@ -0,0 +1,55 @@
+
+export interface CompanyInfo {
+  resource?: string
+  entityId: string
+  fullName: string
+  shortName: string
+  slug: string
+  description: string
+}
+
+export interface CustomStyles {
+  resource?: string
+  entityId: string
+  font: CustomFont
+  colors: CustomColors
+}
+
+export interface CustomColors {
+  primaryColor: string
+  secondaryColor?: string
+  alertColor?: string
+  successColor?: string
+  primaryBackground?: string
+  secondaryBackground?: string
+  alertBackground?: string
+  successBackground?: string
+}
+
+export interface CustomFont {
+  fontFamily: string
+  basicSize?: number
+}
+
+export interface CustomMedia {
+  brand: CustomBrand
+}
+
+export interface CustomBrand {
+  squareLogo?: string
+  wideLogo?: string
+}
+
+export interface ProvideParams {
+  entity: string
+}
+
+  export interface CustomUrls {
+  adminUrl: string
+  userUrl: string
+}
+
+export type ProvidedWL<T extends {} = {}> = T & {
+  type: string
+  exists: boolean | null
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "../tsconfig.default.json",
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+    "moduleResolution": "Bundler",
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/consts.ts","./src/index.ts","./src/modules.ts","./src/types.ts","./src/model/company.ts","./src/model/index.ts","./src/model/provider.ts","./src/model/styles.ts"],"version":"5.6.3"}