@dynamic-field-kit/angular 1.2.0 → 1.2.2

package/README.md

@@ -7,10 +7,12 @@ This package exposes Angular components and a convenience NgModule that integrat
 Quick overview
 - Exports `DynamicInput`, `FieldInput`, `MultiFieldInput`, layout components, and `DynamicFieldKitModule`.
 - Uses the shared `fieldRegistry` from `@dynamic-field-kit/core` to resolve Angular field renderers at runtime.
-- Can be consumed as a packaged library, or linked locally from `packages/angular/dist` during development.
+- Can be consumed in two modes: npm package mode for external apps, or local development mode from `packages/angular/dist`.
 - `MultiFieldInput` currently supports `column`, `row`, and `grid` layout values.
 
-Usage (consumer Angular app)
+Mode 1: npm package mode
+
+Use this mode for normal Angular apps outside this monorepo.
 
 1. Install the packages:
 
@@ -82,8 +84,11 @@ export class AppComponent {
 }
 ```
 
-Local development
-- During local development, point your Angular app at the built package output instead of importing from `src/`:
+Mode 2: local development mode
+
+Use this mode only when developing inside this monorepo or when intentionally linking a local build.
+
+1. Point your Angular app at the built package output instead of importing from `src/`:
 
 ```json
 {
@@ -94,7 +99,14 @@ Local development
 }
 ```
 
-- When using a local `file:` dependency on Windows or via symlinked installs, set `preserveSymlinks: true` in the Angular builder options to avoid runtime issues with linked packages.
+2. Build the local Angular package before running the app:
+
+```bash
+cd packages/angular
+npm run build
+```
+
+3. When using a local `file:` dependency on Windows or via symlinked installs, set `preserveSymlinks: true` in the Angular builder options to avoid runtime issues with linked packages.
 
 Build & publish
 - Build locally with `ng-packagr`:
@@ -108,8 +120,9 @@ npm run build
 
 ```bash
 cd packages/angular
-npm publish --access public
-```
+npm run build
+npm run publish:dist
+```
 
 Notes & caveats
 - Register Angular component classes in `fieldRegistry`. Do not register React or Vue renderers when using the Angular adapter.
@@ -119,5 +132,5 @@ Notes & caveats
 - Supported `layout` values are `column`, `row`, and `grid`.
 
 Examples & docs
-- See `example/angular-instructions.md` for detailed wiring steps.
+- See `example/angular-app/angular-instructions.md` for detailed wiring steps.
 - Try the local scaffold at `example/angular-app/` for a hands-on demo.

package/package.json

@@ -1,42 +1,49 @@
-{
-  "name": "@dynamic-field-kit/angular",
-  "version": "1.2.0",
-  "description": "Angular renderer for dynamic-field-kit",
-  "license": "MIT",
-  "private": false,
-  "sideEffects": false,
-  "files": [
-    "dist"
-  ],
-  "peerDependencies": {
-    "@angular/common": ">=13 <22",
-    "@angular/core": ">=13 <22",
-    "@dynamic-field-kit/core": "^1.0.7"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "ng-packagr -p ng-package.json",
-    "clean": "rimraf dist",
-    "prepublishOnly": "npm run clean && npm run build",
-    "release:patch": "npm version patch && npm publish",
-    "release:minor": "npm version minor && npm publish",
-    "release:major": "npm version major && npm publish"
-  },
-  "devDependencies": {
-    "@angular/common": "^15.2.10",
-    "@angular/core": "^15.2.10",
-    "ng-packagr": "^15.2.2",
-    "rimraf": "^6.1.3"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vannt-dev/dynamic-field-kit.git"
-  },
-  "keywords": [
-    "dynamic-field",
-    "dynamic-field-kit",
-    "dynamic-field-kit/angular"
-  ]
-}
+{
+  "name": "@dynamic-field-kit/angular",
+  "version": "1.2.2",
+  "description": "Angular renderer for dynamic-field-kit",
+  "license": "MIT",
+  "private": false,
+  "sideEffects": false,
+  "main": "fesm2015/dynamic-field-kit-angular.mjs",
+  "types": "index.d.ts",
+  "peerDependencies": {
+    "@angular/common": ">=13 <22",
+    "@angular/core": ">=13 <22",
+    "@dynamic-field-kit/core": "^1.0.7"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vannt-dev/dynamic-field-kit.git"
+  },
+  "keywords": [
+    "dynamic-field",
+    "dynamic-field-kit",
+    "dynamic-field-kit/angular"
+  ],
+  "module": "fesm2015/dynamic-field-kit-angular.mjs",
+  "es2020": "fesm2020/dynamic-field-kit-angular.mjs",
+  "esm2020": "esm2020/dynamic-field-kit-angular.mjs",
+  "fesm2020": "fesm2020/dynamic-field-kit-angular.mjs",
+  "fesm2015": "fesm2015/dynamic-field-kit-angular.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2020": "./esm2020/dynamic-field-kit-angular.mjs",
+      "es2020": "./fesm2020/dynamic-field-kit-angular.mjs",
+      "es2015": "./fesm2015/dynamic-field-kit-angular.mjs",
+      "node": "./fesm2015/dynamic-field-kit-angular.mjs",
+      "default": "./fesm2020/dynamic-field-kit-angular.mjs"
+    }
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
+}

package/dist/README.md

@@ -1,123 +0,0 @@
-# @dynamic-field-kit/angular
-
-Lightweight Angular adapters for `@dynamic-field-kit/core`.
-
-This package exposes Angular components and a convenience NgModule that integrate with the shared `fieldRegistry` from `@dynamic-field-kit/core`.
-
-Quick overview
-- Exports `DynamicInput`, `FieldInput`, `MultiFieldInput`, layout components, and `DynamicFieldKitModule`.
-- Uses the shared `fieldRegistry` from `@dynamic-field-kit/core` to resolve Angular field renderers at runtime.
-- Can be consumed as a packaged library, or linked locally from `packages/angular/dist` during development.
-- `MultiFieldInput` currently supports `column`, `row`, and `grid` layout values.
-
-Usage (consumer Angular app)
-
-1. Install the packages:
-
-```bash
-npm install @dynamic-field-kit/core @dynamic-field-kit/angular
-```
-
-2. Import `DynamicFieldKitModule` in your Angular module:
-
-```ts
-import { DynamicFieldKitModule } from '@dynamic-field-kit/angular'
-
-@NgModule({
-	imports: [BrowserModule, DynamicFieldKitModule],
-})
-export class AppModule {}
-```
-
-3. Register your Angular field components in the shared registry before bootstrap:
-
-```ts
-// src/main.ts
-import 'zone.js'
-import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'
-import { fieldRegistry } from '@dynamic-field-kit/angular'
-import { AppModule } from './app/app.module'
-import { TextFieldComponent } from './app/components/text-field.component'
-import { NumberFieldComponent } from './app/components/number-field.component'
-
-fieldRegistry.register('text', TextFieldComponent as any)
-fieldRegistry.register('number', NumberFieldComponent as any)
-
-platformBrowserDynamic()
-  .bootstrapModule(AppModule)
-  .catch((err) => console.error(err))
-```
-
-4. Render fields in a template:
-
-```html
-<dfk-multi-field-input
-  [fieldDescriptions]="fields"
-  [properties]="data"
-  (onChange)="onChange($event)"
-></dfk-multi-field-input>
-```
-
-5. Example component state:
-
-```ts
-import { Component } from '@angular/core'
-import { FieldDescription } from '@dynamic-field-kit/core'
-
-@Component({
-  selector: 'app-root',
-  templateUrl: './app.component.html',
-})
-export class AppComponent {
-  fields: FieldDescription[] = [
-    { name: 'name', type: 'text', label: 'Name' },
-    { name: 'age', type: 'number', label: 'Age' },
-  ]
-
-  data: any = {}
-
-  onChange(data: any) {
-    this.data = data
-  }
-}
-```
-
-Local development
-- During local development, point your Angular app at the built package output instead of importing from `src/`:
-
-```json
-{
-  "dependencies": {
-    "@dynamic-field-kit/core": "file:../../packages/core",
-    "@dynamic-field-kit/angular": "file:../../packages/angular/dist"
-  }
-}
-```
-
-- When using a local `file:` dependency on Windows or via symlinked installs, set `preserveSymlinks: true` in the Angular builder options to avoid runtime issues with linked packages.
-
-Build & publish
-- Build locally with `ng-packagr`:
-
-```bash
-cd packages/angular
-npm run build
-```
-
-- Publish to npm:
-
-```bash
-cd packages/angular
-npm publish --access public
-```
-
-Notes & caveats
-- Register Angular component classes in `fieldRegistry`. Do not register React or Vue renderers when using the Angular adapter.
-- `DynamicFieldKitModule` is the recommended integration path for consumer apps.
-- Standalone exports are still available for advanced composition, but most apps should start with the module.
-- Text fields default to an empty string when no value is present, so empty controls render as blank instead of `undefined`.
-- Supported `layout` values are `column`, `row`, and `grid`.
-
-Examples & docs
-- See `example/angular-instructions.md` for detailed wiring steps.
-- Try the local scaffold at `example/angular-app/` for a hands-on demo.

package/dist/package.json

@@ -1,50 +0,0 @@
-{
-  "name": "@dynamic-field-kit/angular",
-  "version": "1.2.0",
-  "description": "Angular renderer for dynamic-field-kit",
-  "license": "MIT",
-  "private": false,
-  "sideEffects": false,
-  "files": [
-    "dist"
-  ],
-  "peerDependencies": {
-    "@angular/common": ">=13 <22",
-    "@angular/core": ">=13 <22",
-    "@dynamic-field-kit/core": "^1.0.7"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vannt-dev/dynamic-field-kit.git"
-  },
-  "keywords": [
-    "dynamic-field",
-    "dynamic-field-kit",
-    "dynamic-field-kit/angular"
-  ],
-  "module": "fesm2015/dynamic-field-kit-angular.mjs",
-  "es2020": "fesm2020/dynamic-field-kit-angular.mjs",
-  "esm2020": "esm2020/dynamic-field-kit-angular.mjs",
-  "fesm2020": "fesm2020/dynamic-field-kit-angular.mjs",
-  "fesm2015": "fesm2015/dynamic-field-kit-angular.mjs",
-  "typings": "index.d.ts",
-  "exports": {
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "types": "./index.d.ts",
-      "esm2020": "./esm2020/dynamic-field-kit-angular.mjs",
-      "es2020": "./fesm2020/dynamic-field-kit-angular.mjs",
-      "es2015": "./fesm2015/dynamic-field-kit-angular.mjs",
-      "node": "./fesm2015/dynamic-field-kit-angular.mjs",
-      "default": "./fesm2020/dynamic-field-kit-angular.mjs"
-    }
-  },
-  "dependencies": {
-    "tslib": "^2.3.0"
-  }
-}