@ingcreators/annot-product-docs-astro 0.4.0 → 0.5.0
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/CHANGELOG.md +10 -0
- package/README.md +2 -1
- package/dist/index.js +2 -2
- package/package.json +5 -9
- package/dist/playwright/index.d.ts +0 -36
- package/dist/playwright/index.js +0 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# @ingcreators/annot-product-docs-astro
|
|
2
2
|
|
|
3
|
+
## 0.5.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- **Breaking:** removed the deprecated `./playwright` re-export
|
|
8
|
+
subpath (announced via the import-time `DeprecationWarning`
|
|
9
|
+
shipped since 0.4.0). Import `test` / `expect` /
|
|
10
|
+
`patchScreenshot` from `@ingcreators/annot-product-docs` (MDX
|
|
11
|
+
support) or `@ingcreators/annot-playwright` (without) instead.
|
|
12
|
+
|
|
3
13
|
## 0.4.0
|
|
4
14
|
|
|
5
15
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -95,7 +95,8 @@ PNG verbatim with `hadBoundingBoxes: false`.
|
|
|
95
95
|
> `@ingcreators/annot-product-docs-astro/playwright` moved out
|
|
96
96
|
> of this package as part of
|
|
97
97
|
> [`docs/plans/_done/playwright-screenshot-fixture-relayer.md`](https://github.com/ingcreators/annot/blob/main/docs/plans/_done/playwright-screenshot-fixture-relayer.md)
|
|
98
|
-
> (Phases 1–4)
|
|
98
|
+
> (Phases 1–4), and the deprecated re-export subpath was REMOVED
|
|
99
|
+
> in 0.5.0. Code authoring a Playwright spec should pick
|
|
99
100
|
> one of the two canonical homes:
|
|
100
101
|
|
|
101
102
|
| Use case | Import |
|
package/dist/index.js
CHANGED
|
@@ -104,13 +104,13 @@ async function L(e) {
|
|
|
104
104
|
}
|
|
105
105
|
let w = e.basePngBytes ?? await V(r, o.src, _), E = H(w), D, O = z(w);
|
|
106
106
|
D = O ? h(O) : y(r.commentBlocks.snapshot ?? "");
|
|
107
|
-
let k = b
|
|
107
|
+
let k = b?.file.annotations ? p(b.file.annotations, D) : [], A = k.length > 0 ? await c(w, k) : w;
|
|
108
108
|
!b && o.overlays.length > 0 && C({
|
|
109
109
|
mdxPath: e.mdxPath,
|
|
110
110
|
screenId: e.screenId,
|
|
111
111
|
overlayCount: o.overlays.length
|
|
112
112
|
});
|
|
113
|
-
let j = b ? f(b.file.overlays, D, E) : d(o.overlays, D, E), M = [...b
|
|
113
|
+
let j = b ? f(b.file.overlays, D, E) : d(o.overlays, D, E), M = [...b?.file.annotations ? m(b.file.annotations, D, E) : [], ...j], N, P;
|
|
114
114
|
if (M.length === 0) if (P = k.length > 0, u !== null) {
|
|
115
115
|
let e = `data:image/png;base64,${Buffer.from(A).toString("base64")}`;
|
|
116
116
|
N = l({ loadSystemFonts: !0 }).toEditablePng({
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ingcreators/annot-product-docs-astro",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Astro integration for `@ingcreators/annot-product-docs`. Wires the MDX components (`<Screen>` / `<Overlay>` / `<Transition>` / `<HistoryEntry>` / `<ScreenList>` / `<TransitionGraph>`) into an Astro site and supplies the Image Service that renders annotated PNGs from `<Screen>` blocks at build time. Phase 2 of docs/plans/living-product-docs.md.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "ingcreators",
|
|
@@ -33,10 +33,6 @@
|
|
|
33
33
|
"types": "./dist/index.d.ts",
|
|
34
34
|
"default": "./dist/index.js"
|
|
35
35
|
},
|
|
36
|
-
"./playwright": {
|
|
37
|
-
"types": "./dist/playwright/index.d.ts",
|
|
38
|
-
"default": "./dist/playwright/index.js"
|
|
39
|
-
},
|
|
40
36
|
"./components/Screen.astro": "./dist/components/Screen.astro",
|
|
41
37
|
"./components/Overlay.astro": "./dist/components/Overlay.astro",
|
|
42
38
|
"./components/AnnotCallout.astro": "./dist/components/AnnotCallout.astro",
|
|
@@ -61,15 +57,15 @@
|
|
|
61
57
|
"@playwright/test": "^1.61.1",
|
|
62
58
|
"astro": "^7.0.6",
|
|
63
59
|
"typescript": "^6.0.3",
|
|
64
|
-
"vite": "^8.
|
|
60
|
+
"vite": "^8.1.3",
|
|
65
61
|
"vite-plugin-dts": "^5.0.3"
|
|
66
62
|
},
|
|
67
63
|
"dependencies": {
|
|
68
|
-
"@ingcreators/annot-annotator": "0.6.0",
|
|
69
64
|
"@ingcreators/annot-core": "0.3.1",
|
|
65
|
+
"@ingcreators/annot-annotator": "0.6.0",
|
|
70
66
|
"@ingcreators/annot-playwright": "0.4.2",
|
|
71
|
-
"@ingcreators/annot-
|
|
72
|
-
"@ingcreators/annot-
|
|
67
|
+
"@ingcreators/annot-embed-protocol": "0.1.0",
|
|
68
|
+
"@ingcreators/annot-product-docs": "0.5.0"
|
|
73
69
|
},
|
|
74
70
|
"peerDependencies": {
|
|
75
71
|
"astro": "^5.0.0 || ^6.0.0 || ^7.0.0"
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @deprecated Import `AnnotScreenshotOptions` from
|
|
3
|
-
* `@ingcreators/annot-playwright` — that package owns the
|
|
4
|
-
* canonical interface; `@ingcreators/annot-product-docs` augments
|
|
5
|
-
* it with `mdx`. Re-exporting here is back-compat only and will
|
|
6
|
-
* be removed in `@ingcreators/annot-product-docs-astro@0.5.0`.
|
|
7
|
-
*/
|
|
8
|
-
/**
|
|
9
|
-
* @deprecated Import the rebase helpers (`Clip`, `RebaseResult`,
|
|
10
|
-
* `describeAnnotation`, `rebaseAnnotations`) from
|
|
11
|
-
* `@ingcreators/annot-playwright`. Re-exporting here is
|
|
12
|
-
* back-compat only and will be removed in
|
|
13
|
-
* `@ingcreators/annot-product-docs-astro@0.5.0`.
|
|
14
|
-
*/
|
|
15
|
-
export type { AnnotScreenshotOptions, Clip, RebaseResult } from '@ingcreators/annot-playwright';
|
|
16
|
-
/**
|
|
17
|
-
* @deprecated Import `patchScreenshot` from
|
|
18
|
-
* `@ingcreators/annot-playwright`. Re-exporting here is
|
|
19
|
-
* back-compat only and will be removed in
|
|
20
|
-
* `@ingcreators/annot-product-docs-astro@0.5.0`.
|
|
21
|
-
*/
|
|
22
|
-
export { describeAnnotation, patchScreenshot, rebaseAnnotations, } from '@ingcreators/annot-playwright';
|
|
23
|
-
/**
|
|
24
|
-
* @deprecated Import `test` from `@ingcreators/annot-product-docs`
|
|
25
|
-
* (with MDX support) or `@ingcreators/annot-playwright` (without).
|
|
26
|
-
* Re-exporting here is back-compat only and will be removed in
|
|
27
|
-
* `@ingcreators/annot-product-docs-astro@0.5.0`.
|
|
28
|
-
*/
|
|
29
|
-
export { test } from '@ingcreators/annot-product-docs';
|
|
30
|
-
/**
|
|
31
|
-
* @deprecated Import `expect` from `@ingcreators/annot-playwright`
|
|
32
|
-
* or `@playwright/test` directly. Re-exporting here is back-compat
|
|
33
|
-
* only and will be removed in
|
|
34
|
-
* `@ingcreators/annot-product-docs-astro@0.5.0`.
|
|
35
|
-
*/
|
|
36
|
-
export { expect } from '@playwright/test';
|
package/dist/playwright/index.js
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { test as e } from "@ingcreators/annot-product-docs";
|
|
2
|
-
import { describeAnnotation as t, patchScreenshot as n, rebaseAnnotations as r } from "@ingcreators/annot-playwright";
|
|
3
|
-
import { expect as i } from "@playwright/test";
|
|
4
|
-
//#region src/playwright/index.ts
|
|
5
|
-
typeof process < "u" && typeof process.emitWarning == "function" && !globalThis.__annotProductDocsAstroPlaywrightWarned && (globalThis.__annotProductDocsAstroPlaywrightWarned = !0, process.emitWarning("@ingcreators/annot-product-docs-astro/playwright is deprecated. Import from @ingcreators/annot-product-docs (with MDX support) or @ingcreators/annot-playwright (without). This subpath will be removed in @ingcreators/annot-product-docs-astro@0.5.0.", "DeprecationWarning"));
|
|
6
|
-
//#endregion
|
|
7
|
-
export { t as describeAnnotation, i as expect, n as patchScreenshot, r as rebaseAnnotations, e as test };
|