Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 jkunz
|
f306c1c8f8 | ||
|
jkunz
|
a59dbc12e5 | ||
|
jkunz
|
75d64e1ebd | ||
 philkunz
|
e8438140a7 | ||
|
philkunz
|
3d2e5e48c1 | ||
|
philkunz
|
fa9f2afbad | ||
|
philkunz
|
7a895c15ab | ||
|
philkunz
|
2f04d66ec5 |
-128
@@ -1,128 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- pnpm install -g pnpm
|
||||
- pnpm install -g @shipzone/npmci
|
||||
- npmci npm prepare
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --prod
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "websetup",
|
||||
"shortDescription": "web metadata setup utilities",
|
||||
"description": "A library for setting up basic properties of a web page including meta tags, OpenGraph tags, JSON-LD structured data, with support for dynamic content.",
|
||||
"npmPackagename": "@push.rocks/websetup",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"web development",
|
||||
"SEO",
|
||||
"OpenGraph",
|
||||
"JSON-LD",
|
||||
"meta tags",
|
||||
"structured data",
|
||||
"TypeScript",
|
||||
"dynamic content",
|
||||
"website setup",
|
||||
"smart delay",
|
||||
"smart promise",
|
||||
"tag management"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-05-01 - 3.0.20 - fix(metadata)
|
||||
update package metadata and align company schema integration with latest tsclass types
|
||||
|
||||
- migrates build and test tooling to the @git.zone packages and adds package exports
|
||||
- updates company-related metadata handling from legacy contact fields to the newer business type shape
|
||||
- makes product publisher data optional and adds safer fallbacks for OpenGraph and JSON-LD tag generation
|
||||
- replaces the browser test with the current chromium-based test entrypoint
|
||||
|
||||
## 2026-03-01 - 3.0.19 - maintenance
|
||||
Repository housekeeping and metadata updates were consolidated for this release line.
|
||||
|
||||
- Removed `.gitlab-ci.yml`
|
||||
- Updated project description
|
||||
- Updated `tsconfig`
|
||||
- Updated `npmextra.json` git host settings
|
||||
|
||||
## 2023-05-08 - 3.0.18 - core
|
||||
Applied a core update as part of the 3.0.16–3.0.18 patch series.
|
||||
|
||||
- Summarized repeated `fix(core): update` changes across versions 3.0.16, 3.0.17, and 3.0.18
|
||||
|
||||
## 2021-12-10 - 3.0.15 - core
|
||||
Applied a core update as part of the 3.0.0–3.0.15 patch series.
|
||||
|
||||
- Summarized repeated `fix(core): update` changes across versions 3.0.0 through 3.0.15
|
||||
|
||||
## 2020-09-22 - 3.0.0 - core
|
||||
Introduced a breaking core update for the 3.0 release line.
|
||||
|
||||
- Breaking change from version 2.0.18 to 3.0.0 due to core update
|
||||
|
||||
## 2020-07-08 - 2.0.18 - core
|
||||
Introduced a breaking core update for the 2.x release line.
|
||||
|
||||
- Breaking change from version 1.0.8 to 2.0.18 due to core update
|
||||
|
||||
## 2020-06-27 - 2.0.17 - core
|
||||
Routine core maintenance updates were released across the 2.0.3–2.0.17 range.
|
||||
|
||||
- Summarized repeated `fix(core): update` changes across versions 2.0.3 through 2.0.17
|
||||
|
||||
## 2019-07-16 - 1.0.8 - core
|
||||
Removed service worker support in a breaking core change.
|
||||
|
||||
- BREAKING CHANGE: remove serviceworker
|
||||
|
||||
## 2019-03-27 - 1.0.7 - core
|
||||
Routine core maintenance updates were released across the 1.0.1–1.0.7 range.
|
||||
|
||||
- Summarized repeated `fix(core): update` changes across versions 1.0.1 through 1.0.7
|
||||
@@ -1,4 +1,4 @@
|
||||
Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
|
||||
Copyright (c) 2026 Task Venture Capital GmbH <hello@task.vc>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
+34
-9
@@ -1,17 +1,42 @@
|
||||
{
|
||||
"npmci": {
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "websetup",
|
||||
"description": "setup basic page properties",
|
||||
"npmPackagename": "@pushrocks/websetup",
|
||||
"license": "MIT"
|
||||
}
|
||||
"shortDescription": "web metadata setup utilities",
|
||||
"description": "A library for setting up basic properties of a web page including meta tags, OpenGraph tags, JSON-LD structured data, with support for dynamic content.",
|
||||
"npmPackagename": "@push.rocks/websetup",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"web development",
|
||||
"SEO",
|
||||
"OpenGraph",
|
||||
"JSON-LD",
|
||||
"meta tags",
|
||||
"structured data",
|
||||
"TypeScript",
|
||||
"dynamic content",
|
||||
"website setup",
|
||||
"smart delay",
|
||||
"smart promise",
|
||||
"tag management"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
+35
-16
@@ -1,31 +1,43 @@
|
||||
{
|
||||
"name": "@pushrocks/websetup",
|
||||
"version": "3.0.19",
|
||||
"name": "@push.rocks/websetup",
|
||||
"version": "3.0.20",
|
||||
"private": false,
|
||||
"description": "setup basic page properties",
|
||||
"description": "A library for setting up basic properties of a web page including meta tags, OpenGraph tags, JSON-LD structured data, with support for dynamic content.",
|
||||
"exports": {
|
||||
".": "./dist_ts/index.js"
|
||||
},
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
"author": "Task Venture Capital GmbH <hello@task.vc>",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
|
||||
"test": "tstest test/",
|
||||
"build": "tsbuild --web && tsbundle npm",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"keywords": [
|
||||
"lossless",
|
||||
"websafe"
|
||||
"web development",
|
||||
"SEO",
|
||||
"OpenGraph",
|
||||
"JSON-LD",
|
||||
"meta tags",
|
||||
"structured data",
|
||||
"TypeScript",
|
||||
"dynamic content",
|
||||
"website setup",
|
||||
"smart delay",
|
||||
"smart promise",
|
||||
"tag management"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.65",
|
||||
"@gitzone/tsbundle": "^2.0.7",
|
||||
"@gitzone/tstest": "^1.0.74",
|
||||
"@pushrocks/tapbundle": "^5.0.4"
|
||||
"@git.zone/tsbuild": "^4.4.0",
|
||||
"@git.zone/tsbundle": "^2.10.1",
|
||||
"@git.zone/tstest": "^3.6.3",
|
||||
"@types/node": "^25.6.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartdelay": "^3.0.1",
|
||||
"@pushrocks/smartpromise": "^4.0.2",
|
||||
"@tsclass/tsclass": "^4.0.41"
|
||||
"@push.rocks/smartpromise": "^4.2.4",
|
||||
"@tsclass/tsclass": "^9.5.1"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@@ -36,11 +48,18 @@
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
".smartconfig.json",
|
||||
"license",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"type": "module"
|
||||
"type": "module",
|
||||
"homepage": "https://code.foss.global/push.rocks/websetup",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/websetup.git"
|
||||
}
|
||||
}
|
||||
|
||||
Generated
+6932
-3840
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1 @@
|
||||
|
||||
@@ -1,37 +1,151 @@
|
||||
# @pushrocks/websetup
|
||||
# @push.rocks/websetup
|
||||
setup basic page properties
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/websetup)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/websetup)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/websetup)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/websetup/)
|
||||
## Install
|
||||
To install @push.rocks/websetup, you can use npm (Node Package Manager). Simply run the following command in your terminal:
|
||||
|
||||
## Status for master
|
||||
```bash
|
||||
npm install @push.rocks/websetup --save
|
||||
```
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
This will download the package and add it to your project's `node_modules` directory, as well as save it as a dependency in your project's `package.json` file.
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class intellisense.
|
||||
To use @push.rocks/websetup in your web applications to set up basic page properties efficiently, follow these steps and guidelines. The examples are provided using ECMAScript modules (ESM) syntax along with TypeScript for type safety and better tooling support.
|
||||
|
||||
## Contribution
|
||||
First, ensure you import the necessary modules from @push.rocks/websetup in your TypeScript files:
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
```typescript
|
||||
// Import the main class `WebSetup` from the package
|
||||
import { WebSetup } from '@push.rocks/websetup';
|
||||
```
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
### Basic Setup
|
||||
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
Begin by creating an instance of `WebSetup` with basic page properties. This example demonstrates setting up page title, description, and canonical URL.
|
||||
|
||||
```typescript
|
||||
// Create a WebSetup instance with basic meta information
|
||||
const webSetup = new WebSetup({
|
||||
metaObject: {
|
||||
title: 'Example Page Title',
|
||||
description: 'This is a description of the example page.',
|
||||
canonicalDomain: 'https://www.example.com',
|
||||
},
|
||||
});
|
||||
|
||||
// Wait for the setup to complete
|
||||
webSetup.readyPromise.then(() => {
|
||||
console.log('WebSetup is ready.');
|
||||
});
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
#### Setting up Structured Data with JSON-LD
|
||||
|
||||
Structured data is crucial for SEO and enhancing your page's appearance in search results. @push.rocks/websetup allows you to easily setup company, product, or news article information using JSON-LD.
|
||||
|
||||
```typescript
|
||||
// Define company information
|
||||
const companyInfo = {
|
||||
name: 'Example Company Inc.',
|
||||
contact: {
|
||||
website: 'https://www.example.com',
|
||||
logoUrl: 'https://www.example.com/logo.png',
|
||||
phone: '+1234567890',
|
||||
facebookUrl: 'https://facebook.com/example',
|
||||
twitterUrl: 'https://twitter.com/example',
|
||||
},
|
||||
};
|
||||
|
||||
// Pass the company information to WebSetup
|
||||
const webSetupWithCompanyInfo = new WebSetup({
|
||||
metaObject: {
|
||||
title: 'Example Page Title',
|
||||
ldCompany: companyInfo,
|
||||
},
|
||||
});
|
||||
|
||||
// For products
|
||||
const productInfo = {
|
||||
name: 'Example Product',
|
||||
description: 'A detailed description of the example product.',
|
||||
os: 'Web',
|
||||
category: 'SaaS',
|
||||
logoLink: 'https://www.example.com/product-logo.png',
|
||||
};
|
||||
|
||||
// Pass the product information along with company information for structured data setup
|
||||
const webSetupWithProductInfo = new WebSetup({
|
||||
metaObject: {
|
||||
title: 'Product Page Title',
|
||||
ldProduct: productInfo,
|
||||
ldCompany: companyInfo,
|
||||
},
|
||||
});
|
||||
|
||||
// Wait for setup completion
|
||||
webSetupWithProductInfo.readyPromise.then(() => {
|
||||
console.log('WebSetup with product info is ready.');
|
||||
});
|
||||
```
|
||||
|
||||
#### Dynamic Subpage Levels
|
||||
|
||||
You might have a web application where different "subpages" or sections require different meta tags (e.g., title, description). You can dynamically set these properties without recreating the WebSetup instance.
|
||||
|
||||
```typescript
|
||||
// Assume `webSetup` is an existing instance of WebSetup
|
||||
|
||||
// Define meta object for a new subpage
|
||||
const subPageMeta = {
|
||||
title: 'Subpage Title',
|
||||
description: 'Description for the subpage.',
|
||||
};
|
||||
|
||||
// Dynamically set the subpage level
|
||||
webSetup.setSubLevel(subPageMeta).then(() => {
|
||||
console.log('Subpage meta tags are set.');
|
||||
});
|
||||
|
||||
// Revert to base level when leaving the subpage
|
||||
webSetup.revertToBaseLevel();
|
||||
```
|
||||
|
||||
This approach allows developers to manage site-wide and subpage-specific properties efficiently, enhancing user experience and SEO.
|
||||
|
||||
### Handling Ready for Server-Side Rendering (SSR)
|
||||
|
||||
For projects using server-side rendering (SSR), it is essential to signal when the page is ready to be captured. This is especially useful when using SSR solutions like smartSSR that wait for a signal from the client.
|
||||
|
||||
```typescript
|
||||
// Inform that the page is ready for SSR capture
|
||||
webSetup.informReadyForSmartssr();
|
||||
```
|
||||
|
||||
Note: This feature should be used if you have `smartssrWaitForReadySignal` option enabled during the `WebSetup` initialization.
|
||||
|
||||
### Conclusion
|
||||
|
||||
The `@push.rocks/websetup` package provides a streamlined way to manage basic page properties, structured data using JSON-LD for SEO, and dynamic settings for different page sections or states. By following the examples above and integrating @push.rocks/websetup into your projects, you can improve your web application's SEO, maintainability, and developer experience.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { expect, tap, webhelpers } from '@pushrocks/tapbundle';
|
||||
webhelpers.enable();
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as websetup from '../ts/index.js';
|
||||
|
||||
@@ -15,4 +14,4 @@ tap.test('first test', async () => {
|
||||
expect(document.title).toEqual('mytitle');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/websetup',
|
||||
version: '3.0.19',
|
||||
description: 'setup basic page properties'
|
||||
name: '@push.rocks/websetup',
|
||||
version: '3.0.20',
|
||||
description: 'A library for setting up basic properties of a web page including meta tags, OpenGraph tags, JSON-LD structured data, with support for dynamic content.'
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@ export interface IMetaObject {
|
||||
title: string;
|
||||
description?: string;
|
||||
canonicalDomain?: string;
|
||||
ldCompany?: plugins.tsclass.business.ICompany;
|
||||
ldCompany?: plugins.tsclass.business.TCompany;
|
||||
ldProduct?: plugins.tsclass.saas.IProduct;
|
||||
|
||||
// handles
|
||||
|
||||
@@ -4,7 +4,7 @@ import * as interfaces from './interfaces/index.js';
|
||||
import { Tag } from './websetup.classes.tag.js';
|
||||
|
||||
export class JsonLdTag extends Tag {
|
||||
public static createCompanyJsonLd(companyDataArg: plugins.tsclass.business.ICompany) {
|
||||
public static createCompanyJsonLd(companyDataArg: plugins.tsclass.business.TCompany) {
|
||||
// STATIC
|
||||
// lets care about linked data
|
||||
const companyLd = {
|
||||
@@ -12,24 +12,26 @@ export class JsonLdTag extends Tag {
|
||||
'@type': 'Corporation',
|
||||
name: companyDataArg.name,
|
||||
alternateName: companyDataArg.name.replace(' GmbH', ''),
|
||||
url: companyDataArg.contact.website,
|
||||
logo: companyDataArg.contact.logoUrl,
|
||||
url: companyDataArg.website,
|
||||
logo: companyDataArg.logoUrl,
|
||||
contactPoint: {
|
||||
'@type': 'ContactPoint',
|
||||
telephone: companyDataArg.contact.phone,
|
||||
telephone: companyDataArg.phone,
|
||||
contactType: 'customer service',
|
||||
areaServed: 'DE',
|
||||
availableLanguage: ['en', 'German'],
|
||||
},
|
||||
sameAs: [],
|
||||
sameAs: [] as string[],
|
||||
};
|
||||
|
||||
if (companyDataArg.contact.facebookUrl) {
|
||||
companyLd.sameAs.push(companyDataArg.contact.facebookUrl);
|
||||
const facebookUrl = companyDataArg.socials?.find((socialArg) => socialArg.type === 'facebook')?.url;
|
||||
if (facebookUrl) {
|
||||
companyLd.sameAs.push(facebookUrl);
|
||||
}
|
||||
|
||||
if (companyDataArg.contact.twitterUrl) {
|
||||
companyLd.sameAs.push(companyDataArg.contact.twitterUrl);
|
||||
const twitterUrl = companyDataArg.socials?.find((socialArg) => socialArg.type === 'twitter')?.url;
|
||||
if (twitterUrl) {
|
||||
companyLd.sameAs.push(twitterUrl);
|
||||
}
|
||||
|
||||
const ldTag = new JsonLdTag(companyLd);
|
||||
@@ -67,7 +69,7 @@ export class JsonLdTag extends Tag {
|
||||
}
|
||||
public static createProductJsonLd(
|
||||
productArg: plugins.tsclass.saas.IProduct,
|
||||
publisherArg: plugins.tsclass.business.ICompany
|
||||
publisherArg?: plugins.tsclass.business.TCompany
|
||||
) {
|
||||
const productLd = {
|
||||
'@context': 'https://schema.org',
|
||||
@@ -87,7 +89,7 @@ export class JsonLdTag extends Tag {
|
||||
priceCurrency: 'EUR',
|
||||
},
|
||||
},
|
||||
publisher: this.createCompanyJsonLd(publisherArg).elementRef.textContent,
|
||||
publisher: publisherArg ? this.createCompanyJsonLd(publisherArg).elementRef.textContent : undefined,
|
||||
screenshot: 'https://www.social.io/screenshot.png',
|
||||
url: 'https://www.social.io/',
|
||||
};
|
||||
|
||||
@@ -3,9 +3,7 @@ import { Tag } from './websetup.classes.tag.js';
|
||||
export class LinkTag extends Tag {
|
||||
constructor(relArg: string, hrefArg: string) {
|
||||
super();
|
||||
const linkElement = !!document.querySelector("link[rel='canonical']")
|
||||
? document.querySelector("link[rel='canonical']")
|
||||
: document.createElement('link');
|
||||
const linkElement = document.querySelector("link[rel='canonical']") ?? document.createElement('link');
|
||||
linkElement.setAttribute('rel', relArg);
|
||||
linkElement.setAttribute('href', hrefArg);
|
||||
this.elementRef = linkElement;
|
||||
|
||||
@@ -4,23 +4,35 @@ import { Tag } from './websetup.classes.tag.js';
|
||||
export class OpengraphTag extends Tag {
|
||||
public static createNewsArticleOgTags(newsArticleArg: plugins.tsclass.content.IArticle) {
|
||||
const tagArray: OpengraphTag[] = [];
|
||||
tagArray.push(new OpengraphTag('og:url', newsArticleArg.url));
|
||||
tagArray.push(new OpengraphTag('og:url', newsArticleArg.url ?? globalThis.location.href));
|
||||
tagArray.push(new OpengraphTag('og:title', newsArticleArg.title));
|
||||
tagArray.push(new OpengraphTag('og:description', newsArticleArg.content));
|
||||
tagArray.push(new OpengraphTag('og:image', newsArticleArg.featuredImageUrl));
|
||||
tagArray.push(new OpengraphTag('og:image', newsArticleArg.featuredImageUrl ?? ''));
|
||||
return tagArray;
|
||||
}
|
||||
|
||||
public static createProductOgTags(productArg: plugins.tsclass.saas.IProduct) {
|
||||
const tagArray: OpengraphTag[] = [];
|
||||
tagArray.push(new OpengraphTag('og:type', 'product'));
|
||||
tagArray.push(new OpengraphTag('og:url', globalThis.location.href));
|
||||
tagArray.push(new OpengraphTag('og:title', `${productArg.name} - ${productArg.slogan}`));
|
||||
tagArray.push(new OpengraphTag('og:site_name', productArg.name))
|
||||
tagArray.push(new OpengraphTag('og:site_name', productArg.name));
|
||||
tagArray.push(new OpengraphTag('og:description', productArg.description));
|
||||
tagArray.push(new OpengraphTag('og:image', productArg.logoLink));
|
||||
return tagArray;
|
||||
}
|
||||
|
||||
public static createCompanyOgTags(companyArg: plugins.tsclass.business.TCompany) {
|
||||
const tagArray: OpengraphTag[] = [];
|
||||
tagArray.push(new OpengraphTag('og:type', 'company'));
|
||||
tagArray.push(new OpengraphTag('og:url', globalThis.location.href));
|
||||
tagArray.push(new OpengraphTag('og:title', companyArg.name));
|
||||
tagArray.push(new OpengraphTag('og:site_name', companyArg.name));
|
||||
tagArray.push(new OpengraphTag('og:description', companyArg.description));
|
||||
tagArray.push(new OpengraphTag('og:image', companyArg.logoUrl ?? ''));
|
||||
return tagArray;
|
||||
}
|
||||
|
||||
constructor(propertyNameArg: string, contentArg: string) {
|
||||
super();
|
||||
const openGraphElement = document.createElement('meta');
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import * as plugins from './websetup.plugins.js';
|
||||
|
||||
export class Tag {
|
||||
public elementRef: Element;
|
||||
public elementRef!: Element;
|
||||
|
||||
public tagLevel: 'global' | 'levelbound';
|
||||
public tagLevel: 'global' | 'levelbound' = 'levelbound';
|
||||
|
||||
public appendToDom() {
|
||||
if (!this.elementRef.parentElement && !this.elementRef.parentNode) {
|
||||
|
||||
@@ -11,14 +11,14 @@ export type TLevelState = 'enabled' | 'disabled';
|
||||
export class TagLevel {
|
||||
public tagManagerRef: TagManager;
|
||||
|
||||
private titleStore: string;
|
||||
private titleStore?: string;
|
||||
public set title(titleArg: string) {
|
||||
this.titleStore = titleArg;
|
||||
if (this.state === 'enabled') {
|
||||
document.title = this.titleStore;
|
||||
}
|
||||
}
|
||||
public get title() {
|
||||
public get title(): string | undefined {
|
||||
return this.titleStore;
|
||||
}
|
||||
|
||||
@@ -29,6 +29,7 @@ export class TagLevel {
|
||||
|
||||
constructor(tagManagerRefArg: TagManager, levelType: TBaseLevelType) {
|
||||
this.tagManagerRef = tagManagerRefArg;
|
||||
this.type = levelType;
|
||||
}
|
||||
|
||||
public addTag(tagArg: Tag | Tag[]) {
|
||||
@@ -44,34 +45,34 @@ export class TagLevel {
|
||||
}
|
||||
}
|
||||
|
||||
public async addCompanyInfo(companyDataArg: plugins.tsclass.business.ICompany) {
|
||||
public async addCompanyInfo(companyDataArg: plugins.tsclass.business.TCompany) {
|
||||
this.addTag(JsonLdTag.createCompanyJsonLd(companyDataArg));
|
||||
|
||||
// lets care about open graph
|
||||
this.addTag(new OpengraphTag('og:type', 'business.business'));
|
||||
this.addTag(new OpengraphTag('og:title', companyDataArg.name));
|
||||
this.addTag(new OpengraphTag('og:url', companyDataArg.contact.website));
|
||||
this.addTag(new OpengraphTag('og:image', companyDataArg.contact.logoUrl));
|
||||
this.addTag(new OpengraphTag('og:url', companyDataArg.website ?? ''));
|
||||
this.addTag(new OpengraphTag('og:image', companyDataArg.logoUrl ?? ''));
|
||||
this.addTag(
|
||||
new OpengraphTag(
|
||||
'business:contact_data:street_address',
|
||||
`${companyDataArg.contact.address.streetName} ${companyDataArg.contact.address.houseNumber}`
|
||||
`${companyDataArg.address.streetName} ${companyDataArg.address.houseNumber}`
|
||||
)
|
||||
);
|
||||
this.addTag(
|
||||
new OpengraphTag('business:contact_data:locality', companyDataArg.contact.address.postalCode)
|
||||
new OpengraphTag('business:contact_data:locality', companyDataArg.address.postalCode)
|
||||
);
|
||||
this.addTag(
|
||||
new OpengraphTag('business:contact_data:region', companyDataArg.contact.address.city)
|
||||
new OpengraphTag('business:contact_data:region', companyDataArg.address.city)
|
||||
);
|
||||
this.addTag(
|
||||
new OpengraphTag(
|
||||
'business:contact_data:postal_code',
|
||||
companyDataArg.contact.address.postalCode
|
||||
companyDataArg.address.postalCode
|
||||
)
|
||||
);
|
||||
this.addTag(
|
||||
new OpengraphTag('business:contact_data:country_name', companyDataArg.contact.address.country)
|
||||
new OpengraphTag('business:contact_data:country_name', companyDataArg.address.country)
|
||||
);
|
||||
}
|
||||
|
||||
@@ -80,7 +81,7 @@ export class TagLevel {
|
||||
this.addTag(OpengraphTag.createNewsArticleOgTags(articleArg));
|
||||
}
|
||||
|
||||
public addProductInfo(productArg: plugins.tsclass.saas.IProduct, companyArg: plugins.tsclass.business.ICompany) {
|
||||
public addProductInfo(productArg: plugins.tsclass.saas.IProduct, companyArg?: plugins.tsclass.business.TCompany) {
|
||||
this.addTag(JsonLdTag.createProductJsonLd(productArg, companyArg));
|
||||
this.addTag(OpengraphTag.createProductOgTags(productArg));
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@ export class TagManager {
|
||||
|
||||
public baseLevel: TagLevel = new TagLevel(this, 'base');
|
||||
|
||||
public activeLevel: TagLevel;
|
||||
public activeLevel!: TagLevel;
|
||||
|
||||
public async setup(metaObjectArg: interfaces.IMetaObject) {
|
||||
// global tag level
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
// pushrocks scope
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
|
||||
export { smartdelay, smartpromise };
|
||||
export { smartpromise };
|
||||
|
||||
// tsclass scope
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
+10
-4
@@ -3,8 +3,14 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"noImplicitAny": true,
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
"types": ["node"]
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user