@sovereignbase/pwa 0.0.2 → 1.0.1

package/LICENSE

@@ -1,201 +1,201 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
    limitations under the License.

package/README.md

@@ -0,0 +1,180 @@
+[![npm version](https://img.shields.io/npm/v/@sovereignbase/pwa)](https://www.npmjs.com/package/@sovereignbase/pwa)
+[![JSR](https://jsr.io/badges/@sovereignbase/pwa)](https://jsr.io/@sovereignbase/pwa)
+[![CI](https://github.com/sovereignbase/pwa/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/sovereignbase/pwa/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/sovereignbase/pwa/branch/master/graph/badge.svg)](https://codecov.io/gh/sovereignbase/pwa)
+[![license](https://img.shields.io/npm/l/@sovereignbase/pwa)](LICENSE)
+
+# pwa
+
+Build tool for localized, offline-first, search-engine-optimized progressive
+web applications.
+
+## Compatibility
+
+- Runtimes: Node.js and Bun.
+- Input: TypeScript or JavaScript, CSS, assets, and typed language modules.
+- Output: static installers, localized manifests, immutable assets, and a
+  self-rendering Service Worker.
+- Module format: ESM or CJS.
+- Types: bundled `.d.ts`.
+
+## Installation
+
+```sh
+npm install --save-dev @sovereignbase/pwa
+# or
+pnpm add --save-dev @sovereignbase/pwa
+# or
+yarn add --dev @sovereignbase/pwa
+# or
+bun add --dev @sovereignbase/pwa
+```
+
+## Usage
+
+```ts
+import { pwaize } from '@sovereignbase/pwa'
+
+await pwaize({
+  _headersFile: true,
+  alternateLanguages: ['fi'],
+  applicationName: 'Example',
+  assetsDir: './src/client/assets',
+  canonicalLanguage: 'en',
+  defaultLanguage: 'en',
+  description: {
+    en: 'An offline-first example.',
+    fi: 'Offline-first-esimerkki.',
+  },
+  entrypoint: './src/client/index.ts',
+  i18nDir: './src/client/i18n',
+  icons: {
+    icon192: '/assets/icon-192.png',
+    icon512: '/assets/icon-512.png',
+    maskableIcon512: '/assets/icon-maskable-512.png',
+  },
+  openGraphLocale: { en: 'en_US', fi: 'fi_FI' },
+  origin: 'https://example.com',
+  outDir: './dist',
+  serviceWorker: {
+    bypass: ['/api/**', 'https://cdn.example.com/private/**'],
+  },
+  socialImage: {
+    alt: { en: 'Example', fi: 'Esimerkki' },
+    url: 'https://example.com/assets/social.png',
+  },
+  stylesheet: './src/client/style.css',
+  themeColor: '#000000',
+  title: { en: 'Example', fi: 'Esimerkki' },
+  twitter: { creator: '@example', site: '@example' },
+})
+```
+
+## API
+
+### `pwaize(config)`
+
+The package's only runtime export. It bundles, tree-shakes, repeatedly
+minifies, and writes the complete site to `<outDir>/web`.
+
+Values such as titles, descriptions, colors, icons, and metadata are declared
+once. Localizable fields accept either one value or a language record. Lookup
+order is the requested language, `defaultLanguage`, and finally the field's
+empty or default value.
+
+`serviceWorker.bypass` accepts regular expressions and glob strings. `*`
+matches within one path segment, `**` crosses path segments, and an absolute
+pattern matches the complete URL.
+
+## Language modules
+
+TypeScript and JavaScript files under `i18nDir` are individually bundled,
+tree-shaken, and minified to `.js`. Relative imports are bundled, declaration
+files are ignored, and other files are copied.
+
+```ts
+// src/client/i18n/en.ts
+export default {
+  description: 'Available offline.',
+  title: 'Example',
+} as const
+```
+
+The application entrypoint can load the generated module dynamically:
+
+```ts
+const language = document.documentElement.lang
+const content = (await import(`/i18n/${language}.js`)).default
+document.querySelector('h1')!.textContent = content.title
+```
+
+The non-literal import remains dynamic. Generated language modules are included
+in the Service Worker precache.
+
+## Output
+
+```text
+web/
+├── ServiceWorker
+├── index.html
+├── manifest.webmanifest
+├── en/index.html
+├── en/manifest.webmanifest
+├── fi/index.html
+├── fi/manifest.webmanifest
+├── assets/...
+├── i18n/*.js
+└── @sovereignbase/pwa/pwaize-build-id.txt
+```
+
+The root installer and manifest use `defaultLanguage`. Each language also gets
+an indexed installer and manifest. Installers contain only the Service Worker
+loader. The Service Worker renders the application document with its localized
+SEO metadata, bundled stylesheet, and bundled entrypoint.
+
+## Behavior
+
+- JavaScript is bundled and tree-shaken with esbuild, then repeatedly compressed
+  and mangled with Terser.
+- CSS is bundled with esbuild and minified with Lightning CSS.
+- HTML and its inline content are emitted as dense strings.
+- Generated and copied files are precached.
+- Precached static URLs remain files when opened directly in the browser; only
+  application routes use document rendering.
+- Navigation and static resources use stale-while-revalidate caching.
+- Activation deletes old build caches and claims clients.
+- The worker checks a deterministic content build ID and requests an update when
+  deployed content changes.
+- Repeated builds reuse unchanged JavaScript, CSS, and HTML minification results.
+- Generated `_headers` keeps the Service Worker and build ID uncached and gives
+  the assets directory a one-year immutable browser cache.
+
+## Security headers
+
+Generated installers and Service Worker application responses include a
+`Content-Security-Policy`. `script-src` and `style-src` contain SHA-256 hashes
+calculated from the final inline content. They also contain `'unsafe-inline'`
+as a CSP1 fallback; browsers implementing CSP2 or newer ignore that fallback
+when a hash source is present.
+
+The policy also restricts base URLs, framing, forms, objects, workers, fonts,
+media, images, and network connections. Generated `_headers` adds
+`X-Content-Type-Options: nosniff`.
+
+## Example
+
+- Application: [example/entrypoint.js](./example/entrypoint.js)
+- Typed languages: [example/i18n/en.ts](./example/i18n/en.ts) and
+  [example/i18n/fi.ts](./example/i18n/fi.ts)
+- Build driver: [test/index.js](./test/index.js)
+
+## Tests
+
+- Unit and integration tests in Vitest with TypeScript.
+- Browser behavior tests in Playwright with TypeScript.
+- Runtime build tests in Node.js and Bun, including ESM and CJS package wiring.
+- Coverage: 100% statements, branches, functions, and lines.
+
+## License
+
+Apache-2.0

package/dist/{htmlDocument-Cx-dprM5.cjs → htmlDocument-C3k13Sjr.cjs}

@@ -14,13 +14,6 @@
  * limitations under the License.
  */
 
-let _sovereignbase_bytecodec = require("@sovereignbase/bytecodec");
-//#region src/cspHash/index.ts
-const cspHash = async (source) => {
-	const digest = await crypto.subtle.digest("SHA-256", _sovereignbase_bytecodec.Bytes.fromString(source));
-	return `sha256-${_sovereignbase_bytecodec.Bytes.toBase64String(digest)}`;
-};
-//#endregion
 //#region src/seoComponents/jsonldMarkup.ts
 /**
 * Generates Schema.org JSON-LD markup describing a website,
@@ -202,14 +195,14 @@ const documentMarkup = async ({ language, title, applicationName, themeColor, bo
 
     ${headMarkup}
 
-    ${stylesheet ? `<style integrity="${await cspHash(stylesheet)}">
+    ${stylesheet ? `<style>
 ${stylesheet}
     </style>` : ""}
 
   </head>
   <body>
 ${bodyMarkup}
-${entrypoint ? `<script type="module" integrity="${await cspHash(entrypoint)}">
+${entrypoint ? `<script type="module">
 ${entrypoint}
     <\/script>` : ""}
   </body>
@@ -222,4 +215,4 @@ Object.defineProperty(exports, "documentMarkup", {
 	}
 });
 
-//# sourceMappingURL=htmlDocument-Cx-dprM5.cjs.map
+//# sourceMappingURL=htmlDocument-C3k13Sjr.cjs.map

package/dist/htmlDocument-C3k13Sjr.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"htmlDocument-C3k13Sjr.cjs","names":["seo.jsonLDMarkup","seo.languageLinksMarkup","seo.ogMarkup","seo.twitterMarkup"],"sources":["../src/seoComponents/jsonldMarkup.ts","../src/seoComponents/languageLinksMarkup.ts","../src/seoComponents/ogMarkup.ts","../src/seoComponents/twitterMarkup.ts","../src/htmlDocument/index.ts"],"sourcesContent":["import type { JSONLDMarkup } from '../.types/index.js'\n\n/**\n * Generates Schema.org JSON-LD markup describing a website,\n * its web application, the current localized page, and publisher.\n */\nexport const jsonLDMarkup = ({\n  site,\n  application,\n  page,\n  organization,\n}: JSONLDMarkup) => {\n  const siteId = `${site.url}#website`\n  const applicationId = `${application.url}#application`\n  const organizationId = `${organization.url}#organization`\n  const pageId = `${page.url}#webpage`\n\n  const data = {\n    '@context': 'https://schema.org',\n    '@graph': [\n      {\n        '@type': 'WebSite',\n        '@id': siteId,\n        name: site.name,\n        url: site.url,\n        publisher: {\n          '@id': organizationId,\n        },\n      },\n\n      {\n        '@type': 'WebApplication',\n        '@id': applicationId,\n        name: application.name,\n        url: application.url,\n        inLanguage: application.inLanguage,\n\n        ...(application.applicationCategory\n          ? { applicationCategory: application.applicationCategory }\n          : {}),\n\n        ...(application.operatingSystem\n          ? { operatingSystem: application.operatingSystem }\n          : {}),\n\n        ...(application.browserRequirements\n          ? { browserRequirements: application.browserRequirements }\n          : {}),\n\n        ...(application.featureList\n          ? { featureList: application.featureList }\n          : {}),\n\n        ...(application.screenshot\n          ? { screenshot: application.screenshot }\n          : {}),\n\n        publisher: {\n          '@id': organizationId,\n        },\n      },\n\n      {\n        '@type': 'WebPage',\n        '@id': pageId,\n        name: page.name,\n        description: page.description,\n        url: page.url,\n        inLanguage: page.inLanguage,\n\n        isPartOf: {\n          '@id': siteId,\n        },\n\n        mainEntity: {\n          '@id': applicationId,\n        },\n      },\n\n      {\n        '@type': 'Organization',\n        '@id': organizationId,\n        name: organization.name,\n        url: organization.url,\n        logo: {\n          '@type': 'ImageObject',\n          url: organization.logo,\n        },\n      },\n    ],\n  }\n\n  return `\n  <script type=\"application/ld+json\">\n${JSON.stringify(data).replaceAll('<', '\\\\u003c')}\n  </script>\n`\n}\n","import type { BCP47LanguageTag } from '@sovereignbase/utils'\n\n/**\n * Generates canonical and language-alternate link markup for a localized page.\n *\n * Produces:\n * - a canonical link for the current language,\n * - `hreflang` alternate links for each supported alternate language,\n * - an `x-default` alternate link for the default language.\n *\n * @param host Registrable domain, such as `example.com` or `example.co.uk`.\n * @param defaultLanguage Language used for the `x-default` URL.\n * @param canonicalLanguage Language used for the canonical URL.\n * @param alternateLanguages Languages exposed through `hreflang` alternate links.\n * @param pathSuffix Optional path suffix starting with `/`.\n */\nexport const languageLinksMarkup = (\n  host: `${string /* domain */}.${string /* public suffix */}`,\n  defaultLanguage: BCP47LanguageTag,\n  canonicalLanguage: BCP47LanguageTag,\n  alternateLanguages: BCP47LanguageTag[],\n  pathSuffix: '' | `/${string}` = ''\n) => `\n  <link rel=\"canonical\" href=\"https://${host}/${canonicalLanguage}${pathSuffix}\" />\n  ${(() => {\n    let markup = ``\n    for (const language of alternateLanguages)\n      markup += `  <link rel=\"alternate\" hreflang=\"${language}\" href=\"https://${host}/${language}${pathSuffix}\" />`\n    return markup\n  })()}\n  <link rel=\"alternate\" hreflang=\"x-default\" href=\"https://${host}/${defaultLanguage}${pathSuffix}\" />\n`\n","import type { OpenGraphLocale } from '@sovereignbase/utils'\n\n/**\n * Generates Open Graph metadata markup.\n *\n * @param locale Open Graph locale, such as `fi_FI` or `en_US`.\n * @param siteName Site or application name.\n * @param title Page title.\n * @param description Page description.\n * @param url Canonical URL of the page.\n * @param imageUrl URL of the social sharing image.\n * @param imageAlt Alternative text for the social sharing image.\n * @param imageWidth Width of the social sharing image in pixels.\n * @param imageHeight Height of the social sharing image in pixels.\n */\nexport const ogMarkup = (\n  locale: OpenGraphLocale,\n  siteName: string,\n  title: string,\n  description: string,\n  url: `https://${string}`,\n  imageUrl: string,\n  imageAlt: string,\n  imageWidth: number = 1200,\n  imageHeight: number = 630\n) => `\n  <meta property=\"og:locale\" content=\"${locale}\" />\n  <meta property=\"og:type\" content=\"website\" />\n  <meta property=\"og:site_name\" content=\"${siteName}\" />\n  <meta property=\"og:title\" content=\"${title}\" />\n  <meta property=\"og:description\" content=\"${description}\" />\n  <meta property=\"og:url\" content=\"${url}\" />\n  <meta property=\"og:image\" content=\"${imageUrl}\" />\n  <meta property=\"og:image:width\" content=\"${imageWidth}\" />\n  <meta property=\"og:image:height\" content=\"${imageHeight}\" />\n  <meta property=\"og:image:alt\" content=\"${imageAlt}\" />\n`\n","/**\n * Generates Twitter Card metadata markup.\n *\n * @param title Page title.\n * @param description Page description.\n * @param url Canonical URL of the page.\n * @param imageUrl URL of the social sharing image.\n * @param imageAlt Alternative text for the social sharing image.\n * @param site Twitter/X handle of the site.\n * @param creator Twitter/X handle of the content creator.\n */\nexport const twitterMarkup = (\n  title: string,\n  description: string,\n  url: `https://${string}`,\n  imageUrl: string,\n  imageAlt: string,\n  site: `@${string}`,\n  creator: `@${string}`\n) => `\n  <meta name=\"twitter:card\" content=\"summary_large_image\" />\n  <meta name=\"twitter:title\" content=\"${title}\" />\n  <meta name=\"twitter:description\" content=\"${description}\" />\n  <meta name=\"twitter:url\" content=\"${url}\" />\n  <meta name=\"twitter:image\" content=\"${imageUrl}\" />\n  <meta name=\"twitter:image:alt\" content=\"${imageAlt}\" />\n  <meta name=\"twitter:site\" content=\"${site}\" />\n  <meta name=\"twitter:creator\" content=\"${creator}\" />\n`\n","import { DocumentMarkupOptions } from '../.types/index.js'\nimport * as seo from '../seoComponents/index.js'\n/**\n * Generates a complete HTML document for a web application.\n *\n * Supports:\n * - localized document language,\n * - application and theme metadata,\n * - Web App Manifest integration,\n * - favicon and Apple/Safari application icons,\n * - critical inline styles,\n * - inline ES module initialization,\n * - arbitrary additional head markup.\n */\nexport const documentMarkup = async ({\n  language,\n  title,\n  applicationName,\n  themeColor,\n  bodyMarkup = '',\n  headMarkup = '',\n  stylesheet = '',\n  entrypoint = '',\n  iconUrl,\n  appleTouchIconUrl,\n  maskIconUrl,\n  manifestUrl,\n  maskIconColor = themeColor,\n  colorScheme = 'light dark',\n  appleStatusBarStyle = 'black-translucent',\n  seo: documentSEO,\n}: DocumentMarkupOptions): Promise<string> =>\n  `<!DOCTYPE html>\n<html lang=\"${language}\">\n  <head>\n    <meta charset=\"UTF-8\" />\n    <title>${title}</title>\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n\n    <meta name=\"application-name\" content=\"${applicationName}\" />\n    <meta name=\"color-scheme\" content=\"${colorScheme}\" />\n    <meta name=\"theme-color\" content=\"${themeColor}\" />\n\n    <meta name=\"mobile-web-app-capable\" content=\"yes\" />\n    <meta name=\"apple-mobile-web-app-capable\" content=\"yes\" />\n    <meta name=\"apple-mobile-web-app-title\" content=\"${applicationName}\" />\n    <meta\n      name=\"apple-mobile-web-app-status-bar-style\"\n      content=\"${appleStatusBarStyle}\"\n    />\n\n    ${iconUrl ? `<link rel=\"icon\" href=\"${iconUrl}\" />` : ''}\n    ${\n      appleTouchIconUrl\n        ? `<link rel=\"apple-touch-icon\" sizes=\"180x180\" href=\"${appleTouchIconUrl}\" />`\n        : ''\n    }\n    ${\n      maskIconUrl\n        ? `<link rel=\"mask-icon\" href=\"${maskIconUrl}\" color=\"${maskIconColor}\" />`\n        : ''\n    }\n    ${manifestUrl ? `<link rel=\"manifest\" href=\"${manifestUrl}\" />` : ''}\n\n    ${seo.jsonLDMarkup(documentSEO.jsonLD)}\n    ${seo.languageLinksMarkup(\n      documentSEO.languageLinks.host,\n      documentSEO.languageLinks.defaultLanguage,\n      documentSEO.languageLinks.canonicalLanguage,\n      documentSEO.languageLinks.alternateLanguages,\n      documentSEO.languageLinks.pathSuffix\n    )}\n    ${seo.ogMarkup(\n      documentSEO.openGraph.locale,\n      documentSEO.openGraph.siteName,\n      documentSEO.openGraph.title,\n      documentSEO.openGraph.description,\n      documentSEO.openGraph.url,\n      documentSEO.openGraph.imageUrl,\n      documentSEO.openGraph.imageAlt,\n      documentSEO.openGraph.imageWidth,\n      documentSEO.openGraph.imageHeight\n    )}\n    ${seo.twitterMarkup(\n      documentSEO.twitter.title,\n      documentSEO.twitter.description,\n      documentSEO.twitter.url,\n      documentSEO.twitter.imageUrl,\n      documentSEO.twitter.imageAlt,\n      documentSEO.twitter.site,\n      documentSEO.twitter.creator\n    )}\n\n    ${headMarkup}\n\n    ${\n      stylesheet\n        ? `<style>\n${stylesheet}\n    </style>`\n        : ''\n    }\n\n  </head>\n  <body>\n${bodyMarkup}\n${\n  entrypoint\n    ? `<script type=\"module\">\n${entrypoint}\n    </script>`\n    : ''\n}\n  </body>\n</html>`\n    .replace(/>\\s+</g, '><')\n    .trim()\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAMA,MAAa,gBAAgB,EAC3B,MACA,aACA,MACA,mBACkB;CAClB,MAAM,SAAS,GAAG,KAAK,IAAI;CAC3B,MAAM,gBAAgB,GAAG,YAAY,IAAI;CACzC,MAAM,iBAAiB,GAAG,aAAa,IAAI;CAC3C,MAAM,SAAS,GAAG,KAAK,IAAI;CAE3B,MAAM,OAAO;EACX,YAAY;EACZ,UAAU;GACR;IACE,SAAS;IACT,OAAO;IACP,MAAM,KAAK;IACX,KAAK,KAAK;IACV,WAAW,EACT,OAAO,eACT;GACF;GAEA;IACE,SAAS;IACT,OAAO;IACP,MAAM,YAAY;IAClB,KAAK,YAAY;IACjB,YAAY,YAAY;IAExB,GAAI,YAAY,sBACZ,EAAE,qBAAqB,YAAY,oBAAoB,IACvD,CAAC;IAEL,GAAI,YAAY,kBACZ,EAAE,iBAAiB,YAAY,gBAAgB,IAC/C,CAAC;IAEL,GAAI,YAAY,sBACZ,EAAE,qBAAqB,YAAY,oBAAoB,IACvD,CAAC;IAEL,GAAI,YAAY,cACZ,EAAE,aAAa,YAAY,YAAY,IACvC,CAAC;IAEL,GAAI,YAAY,aACZ,EAAE,YAAY,YAAY,WAAW,IACrC,CAAC;IAEL,WAAW,EACT,OAAO,eACT;GACF;GAEA;IACE,SAAS;IACT,OAAO;IACP,MAAM,KAAK;IACX,aAAa,KAAK;IAClB,KAAK,KAAK;IACV,YAAY,KAAK;IAEjB,UAAU,EACR,OAAO,OACT;IAEA,YAAY,EACV,OAAO,cACT;GACF;GAEA;IACE,SAAS;IACT,OAAO;IACP,MAAM,aAAa;IACnB,KAAK,aAAa;IAClB,MAAM;KACJ,SAAS;KACT,KAAK,aAAa;IACpB;GACF;EACF;CACF;CAEA,OAAO;;EAEP,KAAK,UAAU,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,EAAE;;;AAGlD;;;;;;;;;;;;;;;;;ACjFA,MAAa,uBACX,MACA,iBACA,mBACA,oBACA,aAAgC,OAC7B;wCACmC,KAAK,GAAG,oBAAoB,WAAW;WACpE;CACP,IAAI,SAAS;CACb,KAAK,MAAM,YAAY,oBACrB,UAAU,qCAAqC,SAAS,kBAAkB,KAAK,GAAG,WAAW,WAAW;CAC1G,OAAO;AACT,EAAA,CAAG,EAAE;6DACsD,KAAK,GAAG,kBAAkB,WAAW;;;;;;;;;;;;;;;;;ACflG,MAAa,YACX,QACA,UACA,OACA,aACA,KACA,UACA,UACA,aAAqB,MACrB,cAAsB,QACnB;wCACmC,OAAO;;2CAEJ,SAAS;uCACb,MAAM;6CACA,YAAY;qCACpB,IAAI;uCACF,SAAS;6CACH,WAAW;8CACV,YAAY;2CACf,SAAS;;;;;;;;;;;;;;;ACxBpD,MAAa,iBACX,OACA,aACA,KACA,UACA,UACA,MACA,YACG;;wCAEmC,MAAM;8CACA,YAAY;sCACpB,IAAI;wCACF,SAAS;4CACL,SAAS;uCACd,KAAK;0CACF,QAAQ;;;;;;;;;;;;;;;;ACblD,MAAa,iBAAiB,OAAO,EACnC,UACA,OACA,iBACA,YACA,aAAa,IACb,aAAa,IACb,aAAa,IACb,aAAa,IACb,SACA,mBACA,aACA,aACA,gBAAgB,YAChB,cAAc,cACd,sBAAsB,qBACtB,KAAK,kBAEL;cACY,SAAS;;;aAGV,MAAM;;;6CAG0B,gBAAgB;yCACpB,YAAY;wCACb,WAAW;;;;uDAII,gBAAgB;;;iBAGtD,oBAAoB;;;MAG/B,UAAU,0BAA0B,QAAQ,QAAQ,GAAG;MAEvD,oBACI,sDAAsD,kBAAkB,QACxE,GACL;MAEC,cACI,+BAA+B,YAAY,WAAW,cAAc,QACpE,GACL;MACC,cAAc,8BAA8B,YAAY,QAAQ,GAAG;;MAEnEA,aAAiB,YAAY,MAAM,EAAE;MACrCC,oBACA,YAAY,cAAc,MAC1B,YAAY,cAAc,iBAC1B,YAAY,cAAc,mBAC1B,YAAY,cAAc,oBAC1B,YAAY,cAAc,UAC5B,EAAE;MACAC,SACA,YAAY,UAAU,QACtB,YAAY,UAAU,UACtB,YAAY,UAAU,OACtB,YAAY,UAAU,aACtB,YAAY,UAAU,KACtB,YAAY,UAAU,UACtB,YAAY,UAAU,UACtB,YAAY,UAAU,YACtB,YAAY,UAAU,WACxB,EAAE;MACAC,cACA,YAAY,QAAQ,OACpB,YAAY,QAAQ,aACpB,YAAY,QAAQ,KACpB,YAAY,QAAQ,UACpB,YAAY,QAAQ,UACpB,YAAY,QAAQ,MACpB,YAAY,QAAQ,OACtB,EAAE;;MAEA,WAAW;;MAGX,aACI;EACR,WAAW;gBAEH,GACL;;;;EAIH,WAAW;EAEX,aACI;EACJ,WAAW;kBAEP,GACL;;SAGI,QAAQ,UAAU,IAAI,CAAC,CACvB,KAAK"}