« get me outta code hell

generatePageLayout.js « dependencies « content « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/content/dependencies/generatePageLayout.js
blob: c9ab83fb1ae1411cf18f3691269f1ee4ccf75e2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
import {empty, openAggregate} from '../../util/sugar.js';

function sidebarSlots(side) {
  return {
    // Content is a flat HTML array. It'll generate one sidebar section
    // if specified.
    [side + 'Content']: {type: 'html'},

    // Multiple is an array of {content: (HTML)} objects. Each of these
    // will generate one sidebar section.
    [side + 'Multiple']: {
      validate: v =>
        v.arrayOf(
          v.validateProperties({
            content: v.isHTML,
          })),
    },

    // Sticky mode controls which sidebar section(s), if any, follow the
    // scroll position, "sticking" to the top of the browser viewport.
    //
    // 'last' - last or only sidebar box is sticky
    // 'column' - entire column, incl. multiple boxes from top, is sticky
    // 'none' - sidebar not sticky at all, stays at top of page
    //
    // Note: This doesn't affect the content of any sidebar section, only
    // the whole section's containing box (or the sidebar column as a whole).
    [side + 'StickyMode']: {
      validate: v => v.is('last', 'column', 'static'),
    },

    // Collapsing sidebars disappear when the viewport is sufficiently
    // thin. (This is the default.) Override as false to make the sidebar
    // stay visible in thinner viewports, where the page layout will be
    // reflowed so the sidebar is as wide as the screen and appears below
    // nav, above the main content.
    [side + 'Collapse']: {type: 'boolean', default: true},

    // Wide sidebars generally take up more horizontal space in the normal
    // page layout, and should be used if the content of the sidebar has
    // a greater than typical focus compared to main content.
    [side + 'Wide']: {type: 'boolean', defualt: false},
  };
}

export default {
  contentDependencies: [
    'generateColorStyleRules',
    'generateFooterLocalizationLinks',
    'generateStickyHeadingContainer',
    'transformContent',
  ],

  extraDependencies: [
    'cachebust',
    'html',
    'language',
    'to',
    'transformMultiline',
    'wikiData',
  ],

  sprawl({wikiInfo}) {
    return {
      footerContent: wikiInfo.footerContent,
      wikiColor: wikiInfo.color,
      wikiName: wikiInfo.nameShort,
    };
  },

  data({wikiName}) {
    return {
      wikiName,
    };
  },

  relations(relation, sprawl) {
    const relations = {};

    relations.footerLocalizationLinks =
      relation('generateFooterLocalizationLinks');

    relations.stickyHeadingContainer =
      relation('generateStickyHeadingContainer');

    relations.defaultFooterContent =
      relation('transformContent', sprawl.footerContent);

    relations.defaultColorStyleRules =
      relation('generateColorStyleRules', sprawl.wikiColor);

    return relations;
  },

  slots: {
    title: {type: 'html'},
    showWikiNameInTitle: {type: 'boolean', default: true},

    cover: {type: 'html'},

    banner: {type: 'html'},
    bannerPosition: {
      validate: v => v.is('top', 'bottom'),
      default: 'top',
    },

    socialEmbed: {type: 'html'},

    colorStyleRules: {
      validate: v => v.arrayOf(v.isString),
      default: [],
    },

    additionalStyleRules: {
      validate: v => v.arrayOf(v.isString),
      default: [],
    },

    mainClasses: {
      validate: v => v.arrayOf(v.isString),
      default: [],
    },

    // Main

    mainContent: {type: 'html'},

    headingMode: {
      validate: v => v.is('sticky', 'static'),
      default: 'static',
    },

    // Sidebars

    ...sidebarSlots('leftSidebar'),
    ...sidebarSlots('rightSidebar'),

    // Nav & Footer

    navContent: {type: 'html'},
    navBottomRowContent: {type: 'html'},

    navLinkStyle: {
      validate: v => v.is('hierarchical', 'index'),
      default: 'index',
    },

    navLinks: {
      validate: v =>
        v.arrayOf(object => {
          v.isObject(object);

          const aggregate = openAggregate({message: `Errors validating navigation link`});

          aggregate.call(v.validateProperties({
            auto: () => true,
            html: () => true,

            path: () => true,
            title: () => true,
            accent: () => true,
          }), object);

          if (object.auto || object.html) {
            if (object.auto && object.html) {
              aggregate.push(new TypeError(`Don't specify both auto and html`));
            } else if (object.auto) {
              aggregate.call(v.is('home', 'current'), object.auto);
            } else {
              aggregate.call(v.isHTML, object.html);
            }

            if (object.path || object.title) {
              aggregate.push(new TypeError(`Don't specify path or title along with auto or html`));
            }
          } else {
            aggregate.call(v.validateProperties({
              path: v.arrayOf(v.isString),
              title: v.isString,
            }), {
              path: object.path,
              title: object.title,
            });
          }

          aggregate.close();

          return true;
        })
    },

    footerContent: {type: 'html'},
  },

  generate(data, relations, slots, {
    cachebust,
    html,
    language,
    to,
  }) {
    let titleHTML = null;

    if (!html.isBlank(slots.title)) {
      switch (slots.headingMode) {
        case 'sticky':
          titleHTML =
            relations.stickyHeadingContainer.slots({
              title: slots.title,
              cover: slots.cover,
            });
          break;
        case 'static':
          titleHTML = html.tag('h1', slots.title);
          break;
      }
    }

    let footerContent = slots.footerContent;

    if (html.isBlank(footerContent)) {
      footerContent = relations.defaultFooterContent
        .slot('mode', 'multiline');
    }

    const mainHTML =
      html.tag('main', {
        id: 'content',
        class: slots.mainClasses,
      }, [
        titleHTML,

        slots.cover,

        html.tag('div',
          {
            [html.onlyIfContent]: true,
            class: 'main-content-container',
          },
          slots.mainContent),
      ]);

    const footerHTML =
      html.tag('footer',
        {[html.onlyIfContent]: true, id: 'footer'},
        [
          html.tag('div',
            {
              [html.onlyIfContent]: true,
              class: 'footer-content',
            },
            footerContent),

          relations.footerLocalizationLinks,
        ]);

    const navHTML = html.tag('nav',
      {
        [html.onlyIfContent]: true,
        id: 'header',
        class: [
          !empty(slots.navLinks) && 'nav-has-main-links',
          !html.isBlank(slots.navContent) && 'nav-has-content',
          !html.isBlank(slots.navBottomRowContent) && 'nav-has-bottom-row',
        ],
      },
      [
        html.tag('div',
          {
            [html.onlyIfContent]: true,
            class: [
              'nav-main-links',
              'nav-links-' + slots.navLinkStyle,
            ],
          },
          slots.navLinks?.map((cur, i) => {
            let content;

            if (cur.html) {
              content = cur.html;
            } else {
              let title;
              let href;

              switch (cur.auto) {
                case 'home':
                  title = data.wikiName;
                  href = to('localized.home');
                  break;
                case 'current':
                  title = slots.title;
                  href = '';
                  break;
                case null:
                case undefined:
                  title = cur.title;
                  href = to(...cur.path);
                  break;
              }

              content = html.tag('a',
                {href},
                title);
            }

            let className;

            if (cur.auto === 'current') {
              className = 'current';
            } else if (
              slots.navLinkStyle === 'hierarchical' &&
              i === slots.navLinks.length - 1
            ) {
              className = 'current';
            }

            return html.tag('span',
              {class: className},
              [
                html.tag('span',
                  {class: 'nav-link-content'},
                  content),
                html.tag('span',
                  {[html.onlyIfContent]: true, class: 'nav-link-accent'},
                  cur.accent),
              ]);
          })),

        html.tag('div',
          {[html.onlyIfContent]: true, class: 'nav-bottom-row'},
          slots.navBottomRowContent),

        html.tag('div',
          {[html.onlyIfContent]: true, class: 'nav-content'},
          slots.navContent),
      ])

    const generateSidebarHTML = (side, id) => {
      const content = slots[side + 'Content'];
      const multiple = slots[side + 'Multiple'];
      const stickyMode = slots[side + 'StickyMode'];
      const wide = slots[side + 'Wide'];
      const collapse = slots[side + 'Collapse'];

      let sidebarClasses = [];
      let sidebarContent = html.blank();

      if (!html.isBlank(content)) {
        sidebarClasses = ['sidebar'];
        sidebarContent = content;
      } else if (multiple) {
        sidebarClasses = ['sidebar-multiple'];
        sidebarContent =
          multiple
            .filter(Boolean)
            .map(({content}) =>
              html.tag('div',
                {
                  [html.onlyIfContent]: true,
                  class: 'sidebar',
                },
                content));
      }

      return html.tag('div',
        {
          [html.onlyIfContent]: true,
          id,
          class: [
            'sidebar-column',
            wide && 'wide',
            !collapse && 'no-hide',
            stickyMode !== 'static' && `sticky-${stickyMode}`,
            ...sidebarClasses,
          ],
        },
        sidebarContent);
    }

    const sidebarLeftHTML = generateSidebarHTML('leftSidebar', 'sidebar-left');
    const sidebarRightHTML = generateSidebarHTML('rightSidebar', 'sidebar-right');
    const collapseSidebars = slots.leftSidebarCollapse && slots.rightSidebarCollapse;

    const imageOverlayHTML = html.tag('div', {id: 'image-overlay-container'},
      html.tag('div', {id: 'image-overlay-content-container'}, [
        html.tag('a', {id: 'image-overlay-image-container'}, [
          html.tag('img', {id: 'image-overlay-image'}),
          html.tag('img', {id: 'image-overlay-image-thumb'}),
        ]),
        html.tag('div', {id: 'image-overlay-action-container'}, [
          html.tag('div', {id: 'image-overlay-action-content-without-size'},
            language.$('releaseInfo.viewOriginalFile', {
              link: html.tag('a', {class: 'image-overlay-view-original'},
                language.$('releaseInfo.viewOriginalFile.link')),
            })),

          html.tag('div', {id: 'image-overlay-action-content-with-size'}, [
            language.$('releaseInfo.viewOriginalFile.withSize', {
              link: html.tag('a', {class: 'image-overlay-view-original'},
                language.$('releaseInfo.viewOriginalFile.link')),
              size: html.tag('span',
                {[html.joinChildren]: ''},
                [
                  html.tag('span', {id: 'image-overlay-file-size-kilobytes'},
                    language.$('count.fileSize.kilobytes', {
                      kilobytes: html.tag('span', {class: 'image-overlay-file-size-count'}),
                    })),
                  html.tag('span', {id: 'image-overlay-file-size-megabytes'},
                    language.$('count.fileSize.megabytes', {
                      megabytes: html.tag('span', {class: 'image-overlay-file-size-count'}),
                    })),
                ]),
            }),

            html.tag('span', {id: 'image-overlay-file-size-warning'},
              language.$('releaseInfo.viewOriginalFile.sizeWarning')),
          ]),
        ]),
      ]));

    const layoutHTML = [
      navHTML,
      slots.bannerPosition === 'top' && slots.banner,
      // secondaryNavHTML,
      html.tag('div',
        {
          class: [
            'layout-columns',
            !collapseSidebars && 'vertical-when-thin',
            (sidebarLeftHTML || sidebarRightHTML) && 'has-one-sidebar',
            (sidebarLeftHTML && sidebarRightHTML) && 'has-two-sidebars',
            !(sidebarLeftHTML || sidebarRightHTML) && 'has-zero-sidebars',
            sidebarLeftHTML && 'has-sidebar-left',
            sidebarRightHTML && 'has-sidebar-right',
          ],
        },
        [
          sidebarLeftHTML,
          mainHTML,
          sidebarRightHTML,
        ]),
      slots.bannerPosition === 'bottom' && slots.banner,
      footerHTML,
    ].filter(Boolean).join('\n');

    return html.tags([
      `<!DOCTYPE html>`,
      html.tag('html',
        {
          lang: language.intlCode,
          'data-language-code': language.code,

          /*
          'data-url-key': 'localized.' + pagePath[0],
          ...Object.fromEntries(
            pagePath.slice(1).map((v, i) => [['data-url-value' + i], v])),
          */

          'data-rebase-localized': to('localized.root'),
          'data-rebase-shared': to('shared.root'),
          'data-rebase-media': to('media.root'),
          'data-rebase-data': to('data.root'),
        },
        [
          // developersComment,

          html.tag('head', [
            html.tag('title',
              (slots.showWikiNameInTitle
                ? language.formatString('misc.pageTitle.withWikiName', {
                    title: slots.title,
                    wikiName: data.wikiName,
                  })
                : language.formatString('misc.pageTitle', {
                    title: slots.title,
                  }))),

            html.tag('meta', {charset: 'utf-8'}),
            html.tag('meta', {
              name: 'viewport',
              content: 'width=device-width, initial-scale=1',
            }),

            /*
            ...(
              Object.entries(meta)
                .filter(([key, value]) => value)
                .map(([key, value]) => html.tag('meta', {[key]: value}))),

            canonical &&
              html.tag('link', {
                rel: 'canonical',
                href: canonical,
              }),

            ...(
              localizedCanonical
                .map(({lang, href}) => html.tag('link', {
                  rel: 'alternate',
                  hreflang: lang,
                  href,
                }))),

            */

            // slots.socialEmbed,

            html.tag('link', {
              rel: 'stylesheet',
              href: to('shared.staticFile', `site4.css?${cachebust}`),
            }),

            html.tag('style', [
              (empty(slots.colorStyleRules)
                ? relations.defaultColorStyleRules
                : slots.colorStyleRules),
              slots.additionalStyleRules,
            ]),

            html.tag('script', {
              src: to('shared.staticFile', `lazy-loading.js?${cachebust}`),
            }),
          ]),

          html.tag('body',
            // {style: body.style || ''},
            [
              html.tag('div', {id: 'page-container'}, [
                // mainHTML && skippersHTML,
                layoutHTML,
              ]),

              // infoCardHTML,
              imageOverlayHTML,

              html.tag('script', {
                type: 'module',
                src: to('shared.staticFile', `client.js?${cachebust}`),
              }),
            ]),
        ])
    ]);
  },
};