@flowscripter/example-plugin-api 1.0.8 → 1.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.
Files changed (4) hide show
  1. package/.github/workflows/release-bun-library.yml +1 -0
  2. package/README.md +5 -11
  3. package/bun.lock +6 -7
  4. package/package.json +13 -13
package/.github/workflows/release-bun-library.yml CHANGED
@@ -8,6 +8,7 @@ permissions:
8
8
  pull-requests: write
9
9
  id-token: write
10
10
  pages: write
11
+ packages: write
11
12
  jobs:
12
13
  call-release-bun-library:
13
14
  uses: flowscripter/.github/.github/workflows/release-bun-library.yml@v1
package/README.md CHANGED
@@ -18,10 +18,7 @@ Add the module:
18
18
  Use the module:
19
19
 
20
20
  ```typescript
21
- import {
22
- EXTENSION_POINT_1,
23
- ExtensionPoint1,
24
- } from "@flowscripter/example-plugin-api";
21
+ import { EXTENSION_POINT_1, ExtensionPoint1 } from "@flowscripter/example-plugin-api";
25
22
 
26
23
  // ExtensionPoint1 is identified by EXTENSION_POINT_1 identifier
27
24
 
@@ -38,20 +35,17 @@ Test:
38
35
 
39
36
  `bun test`
40
37
 
41
- **NOTE**: The following tasks use Deno as it excels at these and Bun does not
42
- currently provide such functionality:
43
-
44
38
  Format:
45
39
 
46
- `deno fmt`
40
+ `bunx oxfmt`
47
41
 
48
42
  Lint:
49
43
 
50
- `deno lint index.ts`
44
+ `bunx oxlint index.ts`
51
45
 
52
46
  Generate HTML API Documentation:
53
47
 
54
- `deno doc --html --name=example-plugin-api index.ts`
48
+ `bunx typedoc --readme none index.ts`
55
49
 
56
50
  ## Documentation
57
51
 
@@ -59,7 +53,7 @@ Generate HTML API Documentation:
59
53
 
60
54
  ```mermaid
61
55
  classDiagram
62
-
56
+
63
57
  class ExtensionPoint1 {
64
58
  <<interface>>
65
59
  sayHello()
package/bun.lock CHANGED
@@ -1,26 +1,25 @@
1
1
  {
2
2
  "lockfileVersion": 1,
3
+ "configVersion": 0,
3
4
  "workspaces": {
4
5
  "": {
5
6
  "name": "@flowscripter/example-plugin-api",
6
7
  "devDependencies": {
7
- "@types/bun": "^1.2.5",
8
+ "@types/bun": "^1.3.14",
8
9
  },
9
10
  "peerDependencies": {
10
- "typescript": "^5.8.2",
11
+ "typescript": "^6.0.3",
11
12
  },
12
13
  },
13
14
  },
14
15
  "packages": {
15
- "@types/bun": ["@types/bun@1.2.5", "", { "dependencies": { "bun-types": "1.2.5" } }, "sha512-w2OZTzrZTVtbnJew1pdFmgV99H0/L+Pvw+z1P67HaR18MHOzYnTYOi6qzErhK8HyT+DB782ADVPPE92Xu2/Opg=="],
16
+ "@types/bun": ["@types/bun@1.3.14", "", { "dependencies": { "bun-types": "1.3.14" } }, "sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw=="],
16
17
 
17
18
  "@types/node": ["@types/node@22.13.9", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-acBjXdRJ3A6Pb3tqnw9HZmyR3Fiol3aGxRCK1x3d+6CDAMjl7I649wpSd+yNURCjbOUGu9tqtLKnTGxmK6CyGw=="],
18
19
 
19
- "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
20
+ "bun-types": ["bun-types@1.3.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-4N0ig0fEomHt5R0KCFWjovxow98rIoRwKolrYdCcknNwMekCXRnWEUvgu5soYV8QXtVsrUD8B95MBOZGPvr6KQ=="],
20
21
 
21
- "bun-types": ["bun-types@1.2.5", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-3oO6LVGGRRKI4kHINx5PIdIgnLRb7l/SprhzqXapmoYkFl5m4j6EvALvbDVuuBFaamB46Ap6HCUxIXNLCGy+tg=="],
22
-
23
- "typescript": ["typescript@5.8.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
22
+ "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
24
23
 
25
24
  "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
26
25
  }
package/package.json CHANGED
@@ -1,30 +1,30 @@
1
1
  {
2
2
  "name": "@flowscripter/example-plugin-api",
3
+ "version": "1.1.0",
3
4
  "description": "Example plugin API for the https://github.com/flowscripter/dynamic-plugin-framework",
4
- "homepage": "https://github.com/flowscripter/example-plugin-api#readme",
5
- "repository": {
6
- "type": "git",
7
- "url": "git+https://github.com/flowscripter/example-plugin-api.git"
8
- },
9
- "license": "MIT",
10
5
  "keywords": [
11
6
  "bun",
7
+ "dynamic",
12
8
  "example",
13
- "plugin",
14
9
  "framework",
15
- "dynamic",
16
- "import"
10
+ "import",
11
+ "plugin"
17
12
  ],
18
- "module": "index.ts",
13
+ "homepage": "https://github.com/flowscripter/example-plugin-api#readme",
14
+ "license": "MIT",
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "git+https://github.com/flowscripter/example-plugin-api.git"
18
+ },
19
19
  "type": "module",
20
- "version": "1.0.8",
20
+ "module": "index.ts",
21
21
  "publishConfig": {
22
22
  "access": "public"
23
23
  },
24
24
  "devDependencies": {
25
- "@types/bun": "^1.2.5"
25
+ "@types/bun": "^1.3.14"
26
26
  },
27
27
  "peerDependencies": {
28
- "typescript": "^5.8.2"
28
+ "typescript": "^6.0.3"
29
29
  }
30
30
  }