@arcanewizards/sigil 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,97 @@
+# `@arcanewizards/sigil`
+
+[![](https://img.shields.io/npm/v/@arcanewizards/sigil)](https://www.npmjs.com/package/@arcanewizards/sigil)
+
+Application framework for Arcane-based A/V applications.
+
+`@arcanewizards/sigil` provides the runtime glue for standing up an Arcane application, wiring backend and frontend component namespaces, and reusing shared frontend controls, dialogs, toolbars, styling helpers, and CSS assets.
+
+## Installation
+
+```sh
+pnpm add @arcanewizards/sigil
+```
+
+## Main Entry Points
+
+- `@arcanewizards/sigil`
+  Backend/runtime exports such as `runSigilApp`, `AppShell`, `AppRoot`, `AppListenerManager`, logging contexts, and shared runtime types.
+- `@arcanewizards/sigil/frontend`
+  Frontend bootstrap exports such as `startSigilFrontend`, `createSigilFrontendRenderer`, `Debugger`, browser-context helpers, and shared frontend types.
+- `@arcanewizards/sigil/frontend/controls`
+  Shared control primitives.
+- `@arcanewizards/sigil/frontend/dialogs`
+  Shared dialog primitives.
+- `@arcanewizards/sigil/frontend/toolbars`
+  Shared toolbar primitives.
+- `@arcanewizards/sigil/frontend/tooltip`
+  Shared tooltip helpers and boundaries.
+- `@arcanewizards/sigil/frontend/styling`
+  Shared styling helpers such as `cssVariables`, `cnd`, `sigilColorUsage`, and root hint-color helpers.
+- `@arcanewizards/sigil/frontend/preferences`
+  Frontend preference helpers.
+- `@arcanewizards/sigil/frontend/appearance`
+  Appearance-switching UI.
+- `@arcanewizards/sigil/frontend/styles/base.css`
+- `@arcanewizards/sigil/frontend/styles/theme.css`
+- `@arcanewizards/sigil/frontend/styles/sigil.css`
+
+## Backend Usage
+
+```ts
+import { CoreComponents } from '@arcanejs/react-toolkit';
+import { runSigilApp, SIGIL_COMPONENTS } from '@arcanewizards/sigil';
+import pino from 'pino';
+
+type AppApi = {
+  ping: () => string;
+};
+
+const logger = pino();
+
+const app = runSigilApp<AppApi, { greeting: string }>({
+  logger,
+  title: 'Example App',
+  version: '0.1.0',
+  appProps: { greeting: 'hello' },
+  createApp: ({ setAppApi }) => {
+    setAppApi({
+      ping: () => 'pong',
+    });
+
+    return null;
+  },
+  componentNamespaces: [CoreComponents, SIGIL_COMPONENTS],
+});
+
+app.addEventListener('apiChange', (api) => {
+  console.log(api?.ping());
+});
+```
+
+## Frontend Usage
+
+```ts
+import { startSigilFrontend } from '@arcanewizards/sigil/frontend';
+
+startSigilFrontend({
+  appRenderers: [],
+});
+```
+
+In a real app you normally pass your own frontend component renderers through `appRenderers`.
+
+## CSS Assets
+
+For frontend applications, import the exported styles from your app stylesheet:
+
+```css
+@import '@arcanewizards/sigil/frontend/styles/sigil.css';
+@import '@arcanewizards/sigil/frontend/styles/theme.css';
+@import '@arcanewizards/sigil/frontend/styles/base.css';
+```
+
+## Notes
+
+- The package is designed for React-based Arcane applications.
+- The frontend and backend APIs are intentionally split into subpath exports so consumers only import the surface they need.

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@arcanewizards/sigil",
   "description": "Application framework for A/V applications, built on-top of arcanejs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": false,
   "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ArcaneWizards/open-source.git",
+    "directory": "packages/sigil"
+  },
   "exports": {
     ".": {
       "@arcanewizards/source": "./src/index.ts",
@@ -85,30 +90,20 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "rm -rf dist && tsup && pnpm build:styles && check-export-map",
-    "build:styles": "tailwindcss -i ./src/frontend/styles/sigil.css -o ./dist/frontend/styles/sigil.css && cp ./src/frontend/styles/theme.css ./dist/frontend/styles/theme.css && cp ./src/frontend/styles/base.css ./dist/frontend/styles/base.css",
-    "check:types": "tsc --noEmit",
-    "format:fix": "cd .. && pnpm format:fix",
-    "lint": "eslint . --max-warnings 0",
-    "lint:fix": "eslint --fix ."
-  },
   "dependencies": {
     "@arcanejs/diff": "^0.5.2",
     "@arcanejs/protocol": "^0.8.0",
     "@arcanejs/react-toolkit": "^0.15.1",
     "@arcanejs/toolkit": "^8.0.0",
     "@arcanejs/toolkit-frontend": "^0.11.0",
-    "@arcanewizards/net-utils": "workspace:^",
     "lodash": "^4.17.21",
     "pino": "^9.5.0",
     "radix-ui": "^1.4.3",
     "react": "^19.2.0",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "@arcanewizards/net-utils": "^0.1.2"
   },
   "devDependencies": {
-    "@arcanewizards/eslint-config": "workspace:^",
-    "@arcanewizards/typescript-config": "workspace:^",
     "@tailwindcss/cli": "^4.1.13",
     "@types/lodash": "^4.17.13",
     "@types/node": "^25.0.3",
@@ -118,6 +113,16 @@
     "eslint-plugin-better-tailwindcss": "^4.2.0",
     "tailwindcss": "^4.1.13",
     "tsup": "^8.1.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "@arcanewizards/eslint-config": "^0.0.0",
+    "@arcanewizards/typescript-config": "^0.0.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsup && pnpm build:styles && check-export-map",
+    "build:styles": "tailwindcss -i ./src/frontend/styles/sigil.css -o ./dist/frontend/styles/sigil.css && cp ./src/frontend/styles/theme.css ./dist/frontend/styles/theme.css && cp ./src/frontend/styles/base.css ./dist/frontend/styles/base.css",
+    "check:types": "tsc --noEmit",
+    "format:fix": "cd .. && pnpm format:fix",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint --fix ."
   }
-}
+}