@camera.ui/cli 0.0.15 → 0.0.17

package/dist/utils/sort.js

@@ -20,16 +20,12 @@ export function sortDependencies(packageJson) {
 export function sortScripts(packageJson) {
     const sorted = {};
     if (packageJson.scripts) {
-        sorted.scripts = {};
         Object.keys(packageJson.scripts)
             .sort()
             .forEach((name) => {
-            sorted.scripts[name] = packageJson.scripts[name];
+            sorted[name] = packageJson.scripts[name];
         });
     }
-    return {
-        ...packageJson,
-        ...sorted,
-    };
+    return sorted;
 }
 //# sourceMappingURL=sort.js.map

package/dist/utils/sort.js.map

@@ -1 +1 @@
-{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../src/utils/sort.ts"],"names":[],"mappings":"AAAA,yHAAyH;AACzH,MAAM,UAAU,gBAAgB,CAAC,WAAgC;IAC/D,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,CAAC,CAAC;IAEjG,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAErB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;iBAC9B,IAAI,EAAE;iBACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChB,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,WAAW;QACd,GAAG,MAAM;KACV,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,WAAgC;IAC1D,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;QAEpB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;aAC7B,IAAI,EAAE;aACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO;QACL,GAAG,WAAW;QACd,GAAG,MAAM;KACV,CAAC;AACJ,CAAC"}
+{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../src/utils/sort.ts"],"names":[],"mappings":"AAAA,yHAAyH;AACzH,MAAM,UAAU,gBAAgB,CAAC,WAAgC;IAC/D,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,CAAC,CAAC;IAEjG,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAErB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;iBAC9B,IAAI,EAAE;iBACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChB,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC,CAAC,CAAC;QACP,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,WAAW;QACd,GAAG,MAAM;KACV,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,WAAgC;IAC1D,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;aAC7B,IAAI,EAAE;aACN,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/cli",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "camera.ui cli",
   "type": "module",
   "bin": {
@@ -45,7 +45,7 @@
     "@stylistic/eslint-plugin": "^2.9.0",
     "@types/adm-zip": "^0.5.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.7.9",
+    "@types/node": "^22.8.0",
     "@types/prompts": "^2.4.9",
     "@types/semver": "^7.5.8",
     "@typescript-eslint/parser": "^8.11.0",

package/templates/base/README.md

@@ -4,53 +4,191 @@
 
 # {{projectName}}
 
+A plugin for [camera.ui](https://github.com/SeydX/camera.ui) that allows you to extend the functionality of your camera system.
+
+## Setup Development Environment
+
+1. Make sure you have [Node.js](https://nodejs.org) 20.x or later installed
+2. Install dependencies as described below
+
+## Install Development Dependencies
+
+Install Node dependencies:
+```bash
+npm install
+```
+
+For Python plugins, also install Python dependencies:
+```bash
+pip install -r requirements.txt
+pip install -r requirements.dev.txt
+```
+
+Note: Create a virtual environment for Python plugins to avoid conflicts with system packages.
+
+## Update package.json
+
+Open the [`package.json`](./package.json) and customize the following attributes:
+
+- `name` - Must be prefixed with `camera-ui-` or `@username/camera-ui-` (e.g., `camera-ui-motion` or `@john/camera-ui-motion`)
+- `displayName` - The user-friendly name shown in the camera.ui interface
+- `description` - A short description of your plugin's functionality
+- `author` - Your name and email address
+- `homepage` - Link to your plugin's README.md
+- `repository.url` - Link to your GitHub repository
+- `bugs.url` - Link to your GitHub issues page
+
+Set `private` to `false` when you're ready to publish.
+
+## Config Schema
+
+The plugin configuration is defined in `config.schema.json`. This schema defines the configuration options available to users.
+
+Example schema:
+```json
+{
+  "schema": {
+    "items": {
+      "type": "object",
+      "title": "Remove Models",
+      "opened": true,
+      "properties": {
+        "model": {
+          "type": "string",
+          "title": "Model",
+          "description": "Model to use for object detection",
+          "required": true,
+          "store": false,
+          "defaultValue": "yolov9m_320 - FP16",
+          "enum": [
+            "yolo3-tinyu - INT8",
+            "yolo3-tinyu_320 - INT8",
+            "yolo3-tinyu - FP16",
+            "yolo3-tinyu_320 - FP16",
+            "yolov5nu - INT8",
+            "yolov5nu_320 - INT8",
+            "yolov5mu - INT8",
+            "yolov5mu_320 - INT8"
+          ]
+        }
+      },
+      "buttons": [
+        {
+          "label": "Remove",
+          "onSubmit": "onRemove"
+        }
+      ]
+    }
+  }
+}
+```
+
+## Bundle Plugin
+
+To create a production bundle of your plugin:
+
+```bash
+npm run bundle
+```
+
+This will:
+1. Run code quality checks (if enabled)
+2. Build the source code
+3. Copy required files
+4. Create a distributable bundle.zip
+
+The bundled plugin will be available in the `bundle` directory.
+
+## Watch For Changes and Build Automatically
+
 // TODO
 
-### Setup Development Environment
+## Customize Plugin
 
-// TODO: 
+### JavaScript/TypeScript Plugins
 
-### Install Development Dependencies
+The main entry point is `src/index.ts` (or `src/index.js`). Here you can define your plugin's functionality:
 
-// TODO
+```typescript
+import type { BasePlugin, LoggerService, PluginAPI } from '@camera.ui/types';
 
-### Update package.json
+export default class SamplePlugin implements BasePlugin {
+    constructor(logger: LoggerService, api: PluginAPI) {
+        ...
+    }
+}
+```
 
-Open the [`package.json`](./package.json) and change the following attributes:
+### Python Plugins
 
-- `name` - this should be prefixed with `camera-ui-` or `@username/camera-ui-`, is case-sensitive, and contains no spaces nor special characters apart from a dash `-`
-- `displayName` - this is the "nice" name displayed in the camera.ui interface
-- `author` - this should be your name and email address
-- `homepage` - link to your GitHub repo's `README.md`
-- `repository.url` - link to your GitHub repo
-- `bugs.url` - link to your GitHub repo issues page
+The main entry point is `src/main.py`. Example:
 
-When you are ready to publish the plugin you should set `private` to false, or remove the attribute entirely.
+```python
+from camera_ui_python_types import (
+    BasePlugin,
+    LoggerService,
+    PluginAPI,
+)
 
-### Config Schema
+class SamplePlugin(BasePlugin):
+    def __init__(self, logger: LoggerService, api: PluginAPI):
+        ...
 
-// TODO
+def __main__():
+    return SamplePlugin
+```
 
-### Bundle Plugin
+## Publish Package
 
-// TODO
+When your plugin is ready for release:
 
-### Watch For Changes and Build Automatically
+1. Make sure all tests pass and the bundle builds successfully
+2. Choose the appropriate publishing command:
+   ```bash
+   # For alpha releases
+   npm run publish:alpha
 
-// TODO
+   # For beta releases
+   npm run publish:beta
 
-### Customise Plugin
+   # For stable releases
+   npm run publish:latest
+   ```
 
-// TODO
+The CLI will guide you through version selection and publishing.
 
-### Publish Package
+## Best Practices
 
-// TODO
+1. **Version Management**
+   - Use semantic versioning (MAJOR.MINOR.PATCH)
+   - Start with alpha/beta releases for testing
+   - Document breaking changes
 
-### Best Practices
+2. **Code Quality**
+   - Enable and use the provided linting tools
+   - Write clear documentation
+   - Include usage examples
 
-// TODO
+3. **Configuration**
+   - Provide sensible defaults
+   - Validate user input
+   - Document all options
+
+4. **Testing**
+   - Test with different camera.ui versions
+   - Verify all configuration options
+   - Test error handling
+
+5. **Performance**
+   - Minimize dependencies
+   - Optimize resource usage
+   - Handle cleanup properly
 
-### Useful Links
+## Useful Links
 
-// TODO
+- [camera.ui Documentation](https://github.com/SeydX/camera.ui/wiki)
+- [Plugin Development Guide](https://github.com/SeydX/camera.ui/wiki/plugins)
+- [JSON Schema Documentation](https://json-schema.org/)
+- [Node.js Documentation](https://nodejs.org/docs)
+- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
+- [Python Documentation](https://docs.python.org/)