@contractspec/example.in-app-docs 1.9.0 → 2.1.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.
@@ -3,33 +3,33 @@ $ bun run prebuild && bun run build:bundle && bun run build:types
3
3
  $ contractspec-bun-build prebuild
4
4
  $ contractspec-bun-build transpile
5
5
  [contractspec-bun-build] transpile target=bun root=src entries=6
6
- Bundled 6 modules in 40ms
6
+ Bundled 6 modules in 49ms
7
7
 
8
- docs/in-app-docs.docblock.js 2.72 KB (entry point)
9
- ./index.js 5.97 KB (entry point)
8
+ docs/in-app-docs.docblock.js 2.73 KB (entry point)
9
+ ./index.js 5.98 KB (entry point)
10
10
  docs/index.js 2.70 KB (entry point)
11
- ./example.js 1.11 KB (entry point)
12
- ui/index.js 4.87 KB (entry point)
13
- ui/InAppDocsViewer.js 4.86 KB (entry point)
11
+ ./example.js 1.12 KB (entry point)
12
+ ui/index.js 4.88 KB (entry point)
13
+ ui/InAppDocsViewer.js 4.87 KB (entry point)
14
14
 
15
15
  [contractspec-bun-build] transpile target=node root=src entries=6
16
- Bundled 6 modules in 28ms
16
+ Bundled 6 modules in 37ms
17
17
 
18
- docs/in-app-docs.docblock.js 2.66 KB (entry point)
19
- ./index.js 5.90 KB (entry point)
18
+ docs/in-app-docs.docblock.js 2.67 KB (entry point)
19
+ ./index.js 5.91 KB (entry point)
20
20
  docs/index.js 2.64 KB (entry point)
21
- ./example.js 1.1 KB (entry point)
22
- ui/index.js 4.81 KB (entry point)
23
- ui/InAppDocsViewer.js 4.80 KB (entry point)
21
+ ./example.js 1.10 KB (entry point)
22
+ ui/index.js 4.82 KB (entry point)
23
+ ui/InAppDocsViewer.js 4.81 KB (entry point)
24
24
 
25
25
  [contractspec-bun-build] transpile target=browser root=src entries=6
26
- Bundled 6 modules in 35ms
26
+ Bundled 6 modules in 37ms
27
27
 
28
- docs/in-app-docs.docblock.js 2.66 KB (entry point)
29
- ./index.js 5.90 KB (entry point)
28
+ docs/in-app-docs.docblock.js 2.67 KB (entry point)
29
+ ./index.js 5.91 KB (entry point)
30
30
  docs/index.js 2.64 KB (entry point)
31
- ./example.js 1.1 KB (entry point)
32
- ui/index.js 4.81 KB (entry point)
33
- ui/InAppDocsViewer.js 4.80 KB (entry point)
31
+ ./example.js 1.10 KB (entry point)
32
+ ui/index.js 4.82 KB (entry point)
33
+ ui/InAppDocsViewer.js 4.81 KB (entry point)
34
34
 
35
35
  $ contractspec-bun-build types
package/CHANGELOG.md CHANGED
@@ -1,5 +1,42 @@
1
1
  # @contractspec/example.in-app-docs
2
2
 
3
+ ## 2.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 362fbac: feat: improve video
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [b4bfbc5]
12
+ - Updated dependencies [362fbac]
13
+ - Updated dependencies [659d15f]
14
+ - @contractspec/lib.contracts-spec@2.1.0
15
+ - @contractspec/lib.example-shared-ui@2.1.0
16
+
17
+ ## 2.0.0
18
+
19
+ ### Major Changes
20
+
21
+ - a09bafc: feat: optimize performance
22
+
23
+ ### Patch Changes
24
+
25
+ - 7f3203a: fix: make workspace test runs resilient when packages have no tests
26
+
27
+ Updates package test scripts to pass cleanly when no matching test files exist:
28
+ - Uses `bun test --pass-with-no-tests` in Bun-based packages that currently ship without test files.
29
+ - Uses `jest --passWithNoTests` for the UI kit web package.
30
+ - Adds `.vscode-test.mjs` for `vscode-contractspec` so VS Code extension test runs have an explicit config and stop failing on missing default configuration.
31
+
32
+ This keeps `turbo run test` deterministic across the monorepo while preserving existing test execution behavior where tests are present.
33
+
34
+ - Updated dependencies [a09bafc]
35
+ - Updated dependencies [f152678]
36
+ - Updated dependencies [7f3203a]
37
+ - @contractspec/lib.example-shared-ui@2.0.0
38
+ - @contractspec/lib.contracts-spec@2.0.0
39
+
3
40
  ## 1.9.0
4
41
 
5
42
  ### Minor Changes
@@ -23,7 +60,7 @@
23
60
 
24
61
  - Updated dependencies [374fd71]
25
62
  - @contractspec/lib.example-shared-ui@1.15.0
26
- - @contractspec/lib.contracts@1.61.0
63
+ - @contractspec/lib.contracts-spec@1.61.0
27
64
 
28
65
  ## 1.7.0
29
66
 
@@ -35,7 +72,7 @@
35
72
 
36
73
  - Updated dependencies
37
74
  - @contractspec/lib.example-shared-ui@1.14.0
38
- - @contractspec/lib.contracts@1.60.0
75
+ - @contractspec/lib.contracts-spec@1.60.0
39
76
 
40
77
  ## 1.6.0
41
78
 
@@ -47,7 +84,7 @@
47
84
 
48
85
  - Updated dependencies [1a0cf44]
49
86
  - @contractspec/lib.example-shared-ui@1.13.0
50
- - @contractspec/lib.contracts@1.59.0
87
+ - @contractspec/lib.contracts-spec@1.59.0
51
88
 
52
89
  ## 1.5.0
53
90
 
@@ -60,7 +97,7 @@
60
97
  - Updated dependencies [d1f0fd0]
61
98
  - Updated dependencies [4355a9e]
62
99
  - @contractspec/lib.example-shared-ui@1.12.0
63
- - @contractspec/lib.contracts@1.58.0
100
+ - @contractspec/lib.contracts-spec@1.58.0
64
101
 
65
102
  ## 1.4.0
66
103
 
@@ -76,7 +113,7 @@
76
113
  - Updated dependencies [4651e06]
77
114
  - Updated dependencies [ad9d10a]
78
115
  - Updated dependencies [11a5a05]
79
- - @contractspec/lib.contracts@1.57.0
116
+ - @contractspec/lib.contracts-spec@1.57.0
80
117
  - @contractspec/lib.example-shared-ui@1.11.0
81
118
 
82
119
  ## 1.3.1
@@ -86,7 +123,7 @@
86
123
  - fix: improve publish config
87
124
  - Updated dependencies
88
125
  - @contractspec/lib.example-shared-ui@1.10.1
89
- - @contractspec/lib.contracts@1.56.1
126
+ - @contractspec/lib.contracts-spec@1.56.1
90
127
 
91
128
  ## 1.3.0
92
129
 
@@ -98,7 +135,7 @@
98
135
 
99
136
  - Updated dependencies
100
137
  - @contractspec/lib.example-shared-ui@1.10.0
101
- - @contractspec/lib.contracts@1.56.0
138
+ - @contractspec/lib.contracts-spec@1.56.0
102
139
 
103
140
  ## 1.2.0
104
141
 
@@ -110,7 +147,7 @@
110
147
 
111
148
  - Updated dependencies
112
149
  - @contractspec/lib.example-shared-ui@1.9.0
113
- - @contractspec/lib.contracts@1.55.0
150
+ - @contractspec/lib.contracts-spec@1.55.0
114
151
 
115
152
  ## 1.1.0
116
153
 
@@ -122,4 +159,4 @@
122
159
 
123
160
  - Updated dependencies [ec5e95c]
124
161
  - @contractspec/lib.example-shared-ui@1.8.0
125
- - @contractspec/lib.contracts@1.54.0
162
+ - @contractspec/lib.contracts-spec@1.54.0
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/example.ts
2
- import { defineExample } from "@contractspec/lib.contracts";
2
+ import { defineExample } from "@contractspec/lib.contracts-spec";
3
3
  var example = defineExample({
4
4
  meta: {
5
5
  key: "in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -46,7 +46,7 @@ This guide is available via the help menu inside the app, so you can reference i
46
46
  ];
47
47
  registerDocBlocks(inAppDocs);
48
48
  // src/example.ts
49
- import { defineExample } from "@contractspec/lib.contracts";
49
+ import { defineExample } from "@contractspec/lib.contracts-spec";
50
50
  var example = defineExample({
51
51
  meta: {
52
52
  key: "in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,4 +1,4 @@
1
- import type { DocBlock } from '@contractspec/lib.contracts/docs';
1
+ import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
2
2
  /**
3
3
  * DocBlocks for the in-app documentation example.
4
4
  *
@@ -8,4 +8,3 @@ import type { DocBlock } from '@contractspec/lib.contracts/docs';
8
8
  * integrate the documentation.
9
9
  */
10
10
  export declare const inAppDocs: DocBlock[];
11
- //# sourceMappingURL=in-app-docs.docblock.d.ts.map
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/docs/in-app-docs.docblock.ts
3
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
4
4
  var inAppDocs = [
5
5
  {
6
6
  id: "docs.examples.in-app-docs",
@@ -1,2 +1 @@
1
1
  import './in-app-docs.docblock';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/docs/in-app-docs.docblock.ts
3
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
4
4
  var inAppDocs = [
5
5
  {
6
6
  id: "docs.examples.in-app-docs",
package/dist/example.d.ts CHANGED
@@ -4,6 +4,5 @@
4
4
  * This example demonstrates how to use DocBlock to build public documentation
5
5
  * aimed at end users directly within the application UI.
6
6
  */
7
- declare const example: import("@contractspec/lib.contracts").ExampleSpec;
7
+ declare const example: import("@contractspec/lib.contracts-spec").ExampleSpec;
8
8
  export default example;
9
- //# sourceMappingURL=example.d.ts.map
package/dist/example.js CHANGED
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/example.ts
3
- import { defineExample } from "@contractspec/lib.contracts";
3
+ import { defineExample } from "@contractspec/lib.contracts-spec";
4
4
  var example = defineExample({
5
5
  meta: {
6
6
  key: "in-app-docs",
package/dist/index.d.ts CHANGED
@@ -1,4 +1,3 @@
1
1
  export { default as example } from './example';
2
2
  export * from './ui';
3
3
  import './docs';
4
- //# sourceMappingURL=index.d.ts.map
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/docs/in-app-docs.docblock.ts
3
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
4
4
  var inAppDocs = [
5
5
  {
6
6
  id: "docs.examples.in-app-docs",
@@ -47,7 +47,7 @@ This guide is available via the help menu inside the app, so you can reference i
47
47
  ];
48
48
  registerDocBlocks(inAppDocs);
49
49
  // src/example.ts
50
- import { defineExample } from "@contractspec/lib.contracts";
50
+ import { defineExample } from "@contractspec/lib.contracts-spec";
51
51
  var example = defineExample({
52
52
  meta: {
53
53
  key: "in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/example.ts
2
- import { defineExample } from "@contractspec/lib.contracts";
2
+ import { defineExample } from "@contractspec/lib.contracts-spec";
3
3
  var example = defineExample({
4
4
  meta: {
5
5
  key: "in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -46,7 +46,7 @@ This guide is available via the help menu inside the app, so you can reference i
46
46
  ];
47
47
  registerDocBlocks(inAppDocs);
48
48
  // src/example.ts
49
- import { defineExample } from "@contractspec/lib.contracts";
49
+ import { defineExample } from "@contractspec/lib.contracts-spec";
50
50
  var example = defineExample({
51
51
  meta: {
52
52
  key: "in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -1,5 +1,5 @@
1
1
  // src/docs/in-app-docs.docblock.ts
2
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
2
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
3
3
  var inAppDocs = [
4
4
  {
5
5
  id: "docs.examples.in-app-docs",
@@ -5,4 +5,3 @@ import React from 'react';
5
5
  */
6
6
  declare const InAppDocsViewer: React.FC;
7
7
  export default InAppDocsViewer;
8
- //# sourceMappingURL=InAppDocsViewer.d.ts.map
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/docs/in-app-docs.docblock.ts
3
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
4
4
  var inAppDocs = [
5
5
  {
6
6
  id: "docs.examples.in-app-docs",
@@ -1,2 +1 @@
1
1
  export { default as InAppDocsViewer } from './InAppDocsViewer';
2
- //# sourceMappingURL=index.d.ts.map
package/dist/ui/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  // @bun
2
2
  // src/docs/in-app-docs.docblock.ts
3
- import { registerDocBlocks } from "@contractspec/lib.contracts/docs";
3
+ import { registerDocBlocks } from "@contractspec/lib.contracts-spec/docs";
4
4
  var inAppDocs = [
5
5
  {
6
6
  id: "docs.examples.in-app-docs",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/example.in-app-docs",
3
- "version": "1.9.0",
3
+ "version": "2.1.0",
4
4
  "description": "Example showing how to use DocBlock for in-app documentation for non-technical users",
5
5
  "type": "module",
6
6
  "types": "./dist/index.d.ts",
@@ -73,22 +73,22 @@
73
73
  "lint": "bun lint:fix",
74
74
  "lint:fix": "eslint src --fix",
75
75
  "lint:check": "eslint src",
76
- "test": "bun test",
76
+ "test": "bun test --pass-with-no-tests",
77
77
  "prebuild": "contractspec-bun-build prebuild",
78
78
  "typecheck": "tsc --noEmit"
79
79
  },
80
80
  "dependencies": {
81
- "@contractspec/lib.contracts": "1.62.0",
82
- "@contractspec/lib.example-shared-ui": "1.16.0",
81
+ "@contractspec/lib.contracts-spec": "2.1.0",
82
+ "@contractspec/lib.example-shared-ui": "2.1.0",
83
83
  "react": "19.2.4",
84
84
  "react-dom": "19.2.4"
85
85
  },
86
86
  "devDependencies": {
87
- "@contractspec/tool.typescript": "1.62.0",
87
+ "@contractspec/tool.typescript": "2.1.0",
88
88
  "typescript": "^5.9.3",
89
89
  "@types/react": "^19.2.14",
90
90
  "@types/react-dom": "^19.2.2",
91
- "@contractspec/tool.bun": "1.61.0"
91
+ "@contractspec/tool.bun": "2.1.0"
92
92
  },
93
93
  "publishConfig": {
94
94
  "exports": {
@@ -1,5 +1,5 @@
1
- import type { DocBlock } from '@contractspec/lib.contracts/docs';
2
- import { registerDocBlocks } from '@contractspec/lib.contracts/docs';
1
+ import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
2
+ import { registerDocBlocks } from '@contractspec/lib.contracts-spec/docs';
3
3
 
4
4
  /**
5
5
  * DocBlocks for the in-app documentation example.
package/src/example.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { defineExample } from '@contractspec/lib.contracts';
1
+ import { defineExample } from '@contractspec/lib.contracts-spec';
2
2
 
3
3
  /**
4
4
  * Example specification for the in-app documentation example.
@@ -1 +0,0 @@
1
- {"version":3,"file":"in-app-docs.docblock.d.ts","sourceRoot":"","sources":["../../src/docs/in-app-docs.docblock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGjE;;;;;;;GAOG;AAEH,eAAO,MAAM,SAAS,EAAE,QAAQ,EA6C/B,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs/index.ts"],"names":[],"mappings":"AACA,OAAO,wBAAwB,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,QAAA,MAAM,OAAO,mDA0CX,CAAC;AAEH,eAAe,OAAO,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAG/C,cAAc,MAAM,CAAC;AAGrB,OAAO,QAAQ,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"InAppDocsViewer.d.ts","sourceRoot":"","sources":["../../src/ui/InAppDocsViewer.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAmB,MAAM,OAAO,CAAC;AAKxC;;;GAGG;AACH,QAAA,MAAM,eAAe,EAAE,KAAK,CAAC,EAsC5B,CAAC;AAEF,eAAe,eAAe,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC"}