@tuwaio/docs-ui 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/policies.cjs +1 -2
- package/dist/policies.js +1 -2
- package/package.json +10 -2
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
- **Logo:** `RemoteLogo` is an async React Server Component that fetches an SVG (by default the TUWA logo) and renders it as React elements, so it takes `className` and `currentColor`.
|
|
14
14
|
- **Theme switch:** `ThemeSwitcher` is a light/dark switch for any theme state (for example `next-themes`).
|
|
15
15
|
- **Decoration:** `Orb` (an animated sphere in the brand color of a TUWA project), `StarryBackground` (an animated star field on a canvas) and `NoSSR` (renders its children only on the client).
|
|
16
|
-
- **Policy pages:** `policies` lists the TUWA policies (Terms, Privacy, Cookie, Refund, Security, Data Processing Addendum) with their paths and whether they are in force (`publishedPolicies`; footers use `footerPolicies`). `loadPolicy` loads the text of a policy, and `PolicyDocument` renders it with the date of the version, a Download PDF button, anchored sections and a list of sections. The texts and PDFs come from [`TuwaIO/workflows/docs`](https://github.com/TuwaIO/workflows/tree/main/docs).
|
|
16
|
+
- **Policy pages:** `policies` lists the TUWA policies (Terms, Privacy, Cookie, Refund, Security, Data Processing Addendum) with their paths and whether they are in force (`publishedPolicies`; footers use `footerPolicies`). `loadPolicy` loads the text of a policy, and `PolicyDocument` renders it with the date of the version, a Download PDF button, anchored sections and a list of sections. The texts and PDFs come from [`TuwaIO/workflows/docs`](https://github.com/TuwaIO/workflows/tree/main/docs). Code that needs only the list or `loadPolicy` (footers, sitemaps, route handlers) imports them from `@tuwaio/docs-ui/policies`, which has no React, Next.js or Nextra imports.
|
|
17
17
|
- **Stylesheet:** `dist/index.css` contains the `--tuwa-*` theme variables of [`@tuwaio/nova-core`](https://stories.tuwa.io/?path=/docs/packages-nova-core-overview--docs) (light and `.dark`), the styles of the Nextra parts and the Tailwind CSS v4 utilities used by the components, prefixed with `tuwadocs:`.
|
|
18
18
|
|
|
19
19
|
---
|
|
@@ -95,10 +95,10 @@ export default async function RefundPage() {
|
|
|
95
95
|
}
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Footers list the policies in force:
|
|
98
|
+
Footers list the policies in force (`@tuwaio/docs-ui/policies` has only the policy data, so a footer does not pull in the Nextra parts):
|
|
99
99
|
|
|
100
100
|
```tsx
|
|
101
|
-
import { footerPolicies } from '@tuwaio/docs-ui';
|
|
101
|
+
import { footerPolicies } from '@tuwaio/docs-ui/policies';
|
|
102
102
|
|
|
103
103
|
export function PolicyLinks() {
|
|
104
104
|
return (
|
package/dist/policies.cjs
CHANGED
|
@@ -74,8 +74,7 @@ const policies = [
|
|
|
74
74
|
title: "Data Processing Addendum",
|
|
75
75
|
description: "How we process the personal data of your app users on your behalf when you use Quasar Cloud.",
|
|
76
76
|
href: "/dpa",
|
|
77
|
-
published: true
|
|
78
|
-
footer: false
|
|
77
|
+
published: true
|
|
79
78
|
}
|
|
80
79
|
];
|
|
81
80
|
const publishedPolicies = policies.filter((policy) => policy.published);
|
package/dist/policies.js
CHANGED
|
@@ -43,8 +43,7 @@ const policies = [
|
|
|
43
43
|
title: "Data Processing Addendum",
|
|
44
44
|
description: "How we process the personal data of your app users on your behalf when you use Quasar Cloud.",
|
|
45
45
|
href: "/dpa",
|
|
46
|
-
published: true
|
|
47
|
-
footer: false
|
|
46
|
+
published: true
|
|
48
47
|
}
|
|
49
48
|
];
|
|
50
49
|
const publishedPolicies = policies.filter((policy) => policy.published);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tuwaio/docs-ui",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"author": "Oleksandr Tkach",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -15,6 +15,11 @@
|
|
|
15
15
|
"require": "./dist/index.cjs",
|
|
16
16
|
"types": "./dist/index.d.ts"
|
|
17
17
|
},
|
|
18
|
+
"./policies": {
|
|
19
|
+
"types": "./dist/policies.d.ts",
|
|
20
|
+
"import": "./dist/policies.js",
|
|
21
|
+
"require": "./dist/policies.cjs"
|
|
22
|
+
},
|
|
18
23
|
"./dist/index.css": "./dist/index.css",
|
|
19
24
|
"./dist/*": "./dist/*"
|
|
20
25
|
},
|
|
@@ -25,6 +30,9 @@
|
|
|
25
30
|
"dist",
|
|
26
31
|
"socket.json"
|
|
27
32
|
],
|
|
33
|
+
"sideEffects": [
|
|
34
|
+
"*.css"
|
|
35
|
+
],
|
|
28
36
|
"keywords": [
|
|
29
37
|
"react",
|
|
30
38
|
"tailwindcss",
|
|
@@ -49,7 +57,7 @@
|
|
|
49
57
|
}
|
|
50
58
|
],
|
|
51
59
|
"dependencies": {
|
|
52
|
-
"@tuwaio/nova-core": "^0.9.
|
|
60
|
+
"@tuwaio/nova-core": "^0.9.1",
|
|
53
61
|
"clsx": "^2.1.1",
|
|
54
62
|
"html-react-parser": "^6.1.8",
|
|
55
63
|
"tailwind-merge": "^3.7.0"
|