@flowscripter/example-plugin 1.0.7 → 1.0.12

package/README.md

@@ -1,7 +1,7 @@
 # example-plugin
 
 [![version](https://img.shields.io/github/v/release/flowscripter/example-plugin?sort=semver)](https://github.com/flowscripter/example-plugin/releases)
-[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/example-plugin/release-bun-library.yml)](https://github.com/flowscripter/example-plugin/actions/workflows/release-bun-library.yml)
+[![build](https://img.shields.io/github/actions/workflow/status/flowscripter/example-plugin/release-bun-bundle.yml)](https://github.com/flowscripter/example-plugin/actions/workflows/release-bun-bundle.yml)
 [![coverage](https://codecov.io/gh/flowscripter/example-plugin/branch/main/graph/badge.svg?token=EMFT2938ZF)](https://codecov.io/gh/flowscripter/example-plugin)
 [![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/example-plugin/index.html)
 [![license: MIT](https://img.shields.io/github/license/flowscripter/example-plugin)](https://github.com/flowscripter/example-plugin/blob/main/LICENSE)
@@ -9,16 +9,12 @@
 > Example plugin for the
 > [dynamic-plugin-framework](https://github.com/flowscripter/dynamic-plugin-framework)
 
-## Bun Module Usage
-
-Add the module:
-
-`bun add @flowscripter/example-plugin`
+## Bundled Bun Module Usage
 
 Use the module:
 
 ```typescript
-import { ExampleExtension } from "@flowscripter/example-plugin";
+import { ExampleExtension } from "https://unpkg.com/@flowscripter/example-plugin/dist/bundle.js";
 
 const extension = new ExampleExtension();
 
@@ -35,6 +31,12 @@ Test:
 
 `bun test`
 
+Bundle for usage as a
+[dynamic-plugin-framework](https://github.com/flowscripter/dynamic-plugin-framework)
+plugin:
+
+`bun build index.ts --outdir ./dist --entry-naming bundle.js --minify`
+
 **NOTE**: The following tasks use Deno as it excels at these and Bun does not
 currently provide such functionality:
 

package/dist/bundle.js

@@ -0,0 +1 @@
+var d="foo";var b={sayHello:()=>{console.info("hello world")}},f={create:()=>{return Promise.resolve(b)}},h={extensionPoint:d,factory:f,extensionData:new Map([["extension_foo","extension_bar"]])},j={extensionDescriptors:[h],pluginData:new Map([["plugin_foo","plugin_bar"]])},k=j;export{b as exampleExtension,k as default};

package/package.json

@@ -15,20 +15,26 @@
     "dynamic",
     "import"
   ],
-  "module": "index.ts",
+  "module": "dist/bundle.js",
   "type": "module",
-  "version": "1.0.7",
+  "version": "1.0.12",
+  "exports": "./dist/bundle.js",
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.5"
+    "@types/bun": "^1.2.9"
   },
   "peerDependencies": {
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@flowscripter/dynamic-plugin-framework": "^1.3.15",
-    "@flowscripter/example-plugin-api": "^1.0.7"
+    "@flowscripter/dynamic-plugin-framework": "^1.3.16",
+    "@flowscripter/example-plugin-api": "^1.0.8"
   }
 }

package/.github/workflows/check-bun-dependencies.yml

@@ -1,12 +0,0 @@
-name: check-bun-dependencies
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: "0 0 * * *"
-permissions:
-  contents: read
-  pull-requests: write
-jobs:
-  call-check-bun-dependencies:
-    uses: flowscripter/.github/.github/workflows/check-bun-dependencies.yml@v1
-    secrets: inherit

package/.github/workflows/lint-pr-message.yml

@@ -1,13 +0,0 @@
-name: lint-pr-message
-on:
-  pull_request_target:
-    types:
-      - opened
-      - edited
-      - synchronize
-permissions:
-  contents: read
-jobs:
-  call-lint-pr-message:
-    uses: flowscripter/.github/.github/workflows/lint-pr-message.yml@v1
-    secrets: inherit

package/.github/workflows/release-bun-library.yml

@@ -1,14 +0,0 @@
-name: release-bun-library
-on:
-  push:
-    branches: [main]
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-  id-token: write
-  pages: write
-jobs:
-  call-release-bun-library:
-    uses: flowscripter/.github/.github/workflows/release-bun-library.yml@v1
-    secrets: inherit

package/.github/workflows/validate-bun-library-pr.yml

@@ -1,10 +0,0 @@
-name: validate-bun-library-pr
-on:
-  pull_request:
-    branches: [main]
-permissions:
-  contents: read
-jobs:
-  call-validate-bun-library-pr:
-    uses: flowscripter/.github/.github/workflows/validate-bun-library-pr.yml@v1
-    secrets: inherit

package/bun.lock

@@ -1,35 +0,0 @@
-{
-  "lockfileVersion": 1,
-  "workspaces": {
-    "": {
-      "name": "@flowscripter/example-plugin",
-      "dependencies": {
-        "@flowscripter/dynamic-plugin-framework": "^1.3.15",
-        "@flowscripter/example-plugin-api": "^1.0.7",
-      },
-      "devDependencies": {
-        "@types/bun": "^1.2.5",
-      },
-      "peerDependencies": {
-        "typescript": "^5.8.2",
-      },
-    },
-  },
-  "packages": {
-    "@flowscripter/dynamic-plugin-framework": ["@flowscripter/dynamic-plugin-framework@1.3.15", "", { "peerDependencies": { "typescript": "^5.8.2" } }, "sha512-OhFb2IYNajJK3zeXs+BSCqxL7xr4K6AUcUYA67djsZTxDUekJ9Y+BzyfIPXO7qQRAoJpl/5utCJTmFBE5xVz5w=="],
-
-    "@flowscripter/example-plugin-api": ["@flowscripter/example-plugin-api@1.0.7", "", { "peerDependencies": { "typescript": "^5.8.2" } }, "sha512-BPw88SQB35kzN8pU48wi9fHH0NRJfig/jtBaMWw0Orys7HGi4r0lwShJ+DBZ9XlpTKSQcMJsBnPKQE4OQX1DXw=="],
-
-    "@types/bun": ["@types/bun@1.2.5", "", { "dependencies": { "bun-types": "1.2.5" } }, "sha512-w2OZTzrZTVtbnJew1pdFmgV99H0/L+Pvw+z1P67HaR18MHOzYnTYOi6qzErhK8HyT+DB782ADVPPE92Xu2/Opg=="],
-
-    "@types/node": ["@types/node@22.13.9", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-acBjXdRJ3A6Pb3tqnw9HZmyR3Fiol3aGxRCK1x3d+6CDAMjl7I649wpSd+yNURCjbOUGu9tqtLKnTGxmK6CyGw=="],
-
-    "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
-
-    "bun-types": ["bun-types@1.2.5", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-3oO6LVGGRRKI4kHINx5PIdIgnLRb7l/SprhzqXapmoYkFl5m4j6EvALvbDVuuBFaamB46Ap6HCUxIXNLCGy+tg=="],
-
-    "typescript": ["typescript@5.8.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
-
-    "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
-  }
-}

package/index.ts

@@ -1 +0,0 @@
-export { default, exampleExtension } from "./src/ExamplePlugin.ts";

package/src/ExamplePlugin.ts

@@ -1,42 +0,0 @@
-import {
-  EXTENSION_POINT_1,
-  type ExtensionPoint1,
-} from "@flowscripter/example-plugin-api";
-import type {
-  ExtensionDescriptor,
-  ExtensionFactory,
-  Plugin,
-} from "@flowscripter/dynamic-plugin-framework";
-
-export const exampleExtension: ExtensionPoint1 = {
-  sayHello: () => {
-    console.info("hello world");
-  },
-};
-
-const exampleExtensionFactory: ExtensionFactory = {
-  create: () => {
-    return Promise.resolve(exampleExtension);
-  },
-};
-
-const exampleExtensionDescriptor: ExtensionDescriptor = {
-  extensionPoint: EXTENSION_POINT_1,
-
-  factory: exampleExtensionFactory,
-
-  extensionData: new Map<string, string>([[
-    "extension_foo",
-    "extension_bar",
-  ]]),
-};
-
-const examplePlugin: Plugin = {
-  extensionDescriptors: [
-    exampleExtensionDescriptor,
-  ],
-
-  pluginData: new Map<string, string>([["plugin_foo", "plugin_bar"]]),
-};
-
-export default examplePlugin;

package/tests/ExamplePlugin_test.ts

@@ -1,26 +0,0 @@
-import { describe, expect, test } from "bun:test";
-import { default as examplePlugin, exampleExtension } from "../index.ts";
-import type { ExtensionPoint1 } from "@flowscripter/example-plugin-api";
-
-describe("ExamplePlugin Tests", () => {
-  test("Access extension implementation via plugin", async () => {
-    expect(examplePlugin.pluginData?.get("plugin_foo")).toEqual("plugin_bar");
-
-    const extensionDescriptor = examplePlugin.extensionDescriptors[0];
-
-    expect(
-      extensionDescriptor.extensionData?.get("extension_foo"),
-    ).toEqual(
-      "extension_bar",
-    );
-
-    const extension = await extensionDescriptor.factory
-      .create() as ExtensionPoint1;
-
-    extension.sayHello();
-  });
-
-  test("Access extension implementation directly", () => {
-    exampleExtension.sayHello();
-  });
-});

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    // Enable latest features
-    "lib": ["ESNext", "DOM"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}