@beforesemicolon/site-builder 0.30.0 → 0.33.0

package/dist/types/types.d.ts

@@ -1,15 +1,15 @@
-export interface ObjectLiteral {
-    [key: string]: string | number | boolean | ObjectLiteral | ObjectLiteral[] | unknown;
+export interface ObjectLiteral<T = unknown> {
+    [key: string | number | symbol]: [T] extends [unknown] ? string | number | boolean | ObjectLiteral | ObjectLiteral[] | unknown : T;
 }
 export interface StyleObject {
     [key: string]: string | number | StyleObject;
 }
 export type Style = string | StyleObject;
 export interface ContentNode {
-    [key: string]: string | number | boolean | Array<ContentNode | string>;
+    [key: string]: string | number | boolean | Array<ContentNode | string> | undefined;
     name: string;
-    children: Array<ContentNode | string>;
-    id: string;
+    children?: Array<ContentNode | string>;
+    id?: string;
 }
 export type TemplateContent = (string | ContentNode)[];
 export declare enum InputDefinitionType {
@@ -57,27 +57,41 @@ export declare enum TemplateType {
     Page = "page"
 }
 export interface StyleTag extends ObjectLiteral {
-    attributes: Record<string, string>;
+    attributes?: Record<string, string>;
     content?: Style;
 }
 export interface ScriptTag extends ObjectLiteral {
-    attributes: Record<string, string>;
+    attributes?: Record<string, string>;
     content?: string;
 }
 export type Stylesheet = string | string[] | StyleTag;
 export type Script = string | ScriptTag;
+export type MetaTagDefinition = {
+    charset?: string;
+    viewport?: Record<string, string | number>;
+    keywords?: string[];
+    author?: {
+        name: string;
+        url?: string;
+    };
+    canonical?: string;
+    themeColor?: string;
+    languageDirection?: 'ltr' | 'rtl';
+    [attr: string]: string | number | boolean | undefined | ObjectLiteral | string[];
+};
 export interface Template {
     id: string;
     name: string;
     route: string;
     type: TemplateType;
     extends: string;
+    excluded?: boolean;
     lang: string;
     title: string;
     domain: string;
     description: string;
     image?: string;
-    metadata?: Record<string, string>;
+    metadata?: MetaTagDefinition[] | ObjectLiteral;
     scripts?: Script[];
     stylesheets?: Array<Stylesheet>;
     links?: Record<string, string>[];
@@ -85,27 +99,49 @@ export interface Template {
     favicons?: Record<string, string>[];
     manifest?: string;
     content?: TemplateContent | string;
+    widgetsData?: Record<string, ObjectLiteral>;
+    csp?: Record<string, string[]>;
+    preload?: Array<{
+        href: string;
+        as: string;
+        type?: string;
+        media?: string;
+    }>;
+    structuredData?: object;
+}
+export interface RenderContentProps extends ObjectLiteral {
+    env: {
+        id?: string | undefined;
+        assetsOrigin: string | undefined;
+        prod: boolean | undefined;
+    } & ObjectLiteral;
+    $msg: (id: string, values?: ObjectLiteral) => string;
+    $comp: (compId: string, compData?: ObjectLiteral) => string;
 }
+export type RenderWidgetContent = (props: RenderContentProps) => string;
 export interface Widget {
     id: string;
+    type: 'global' | 'local';
     name: string;
     cssSelector?: string;
     scripts?: Script[];
     style?: Style | ((props?: Record<string, unknown>) => Style);
     stylesheets?: Array<Stylesheet>;
     inputs?: InputDefinition<unknown>[];
-    render?: <P>(props: P) => string;
-    content?: string;
+    render?: RenderWidgetContent;
+    content?: TemplateContent | string;
 }
 export interface Component {
     id: string;
-    stylesheets: Stylesheet[];
-    content: ContentNode[];
+    stylesheets?: Stylesheet[];
+    content: TemplateContent | string;
 }
 export interface parseOptions {
+    useCache?: boolean;
     prod?: boolean;
     assetsOrigin?: string;
     components?: Record<string, Component>;
+    locales?: Record<string, ObjectLiteral>;
     fetchWidget?: (id: string) => Widget | null | Promise<Widget | null>;
     fetchTemplate?: (id: string) => Template | null | Promise<Template | null>;
 }

package/dist/types/utils/flatten-object.d.ts

@@ -0,0 +1,2 @@
+import { ObjectLiteral } from '../types.ts';
+export declare function flattenObject(obj: ObjectLiteral, prefix?: string, res?: ObjectLiteral): ObjectLiteral<unknown>;

package/dist/types/utils/input-definitions-to-object.d.ts

@@ -1,2 +1,2 @@
 import { ObjectLiteral, InputDefinition } from '../types.ts';
-export declare function inputDefinitionsToObject(inputDefinitions: InputDefinition[]): ObjectLiteral;
+export declare function inputDefinitionsToObject(inputDefinitions: InputDefinition[]): ObjectLiteral<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@beforesemicolon/site-builder",
-    "version": "0.30.0",
+    "version": "0.33.0",
     "description": "Site builder based on JSON files",
     "engines": {
         "node": ">=18.16.0"
@@ -20,7 +20,6 @@
         "test:watch": "jest --watch",
         "docs:watch": "rm -rf website && NODE_ENV=development nodemon --watch docs -e js,css,md,json --exec 'node node_modules/@beforesemicolon/builder/dist/esm/docs/run.js'",
         "local": "nodemon --watch src -e ts --exec 'npm run build && npm pack && npm link'",
-        "build:browser": "node ",
         "build": "rm -rf dist && npm-run-all lint test && tsc --emitDeclarationOnly && tsx ./build.ts && tsx ./build-client.ts",
         "lint": "eslint ./src && prettier --check .",
         "format": "eslint ./src --fix && prettier --write ."