@dynamic-field-kit/angular 1.0.0 → 1.0.1

package/README.md

@@ -4,6 +4,62 @@ Lightweight Angular adapters for `@dynamic-field-kit/core`.
 
 This package mirrors the React package structure and exposes Angular components that integrate with the shared `fieldRegistry` from `@dynamic-field-kit/core`.
 
-Notes:
-- The Angular package expects Angular runtime (peer) and uses dynamic component creation to mount field renderers registered in the shared registry.
-- This is a minimal scaffold to enable Angular integration patterns similar to the React package.
+Quick overview
+- Exports a minimal Angular integration: `DynamicInput`, `FieldInput`, `MultiFieldInput`, layout components and `DynamicFieldKitModule` (see `src/public-api.ts`).
+- Designed for local development (source import) and can be packaged with `ng-packagr` for distribution.
+
+Usage (consumer Angular app)
+
+1. Install the package (recommended: use packaged artifact or local `file:` during development):
+
+```bash
+# from your Angular app
+npm install @dynamic-field-kit/core @dynamic-field-kit/angular
+```
+
+2. Import the module in your `AppModule`:
+
+```ts
+import { DynamicFieldKitModule } from '@dynamic-field-kit/angular'
+
+@NgModule({
+	imports: [BrowserModule, DynamicFieldKitModule],
+})
+export class AppModule {}
+```
+
+3. Register Angular component classes into the shared registry at app startup (example):
+
+```ts
+// src/main.ts
+import '@dynamic-field-kit/angular/src/examples' // registers example component into fieldRegistry
+```
+
+Then use the Angular adapter components (`dfk-multi-field-input`, etc.) in templates.
+
+Local development
+- You can import the package source directly in your Angular app using `file:` references in `package.json` (see `example/angular-instructions.md` and `example/angular-app/` for a scaffold).
+
+Build & publish
+- This package supports `ng-packagr`. To build locally:
+
+```bash
+cd packages/angular
+npm install --no-audit --no-fund --save-dev ng-packagr rimraf
+npm run build
+```
+
+- To publish to npm (scoped package), ensure `publishConfig.access` is `public` and run:
+
+```bash
+cd packages/angular
+npm publish --access public
+```
+
+Notes & caveats
+- The Angular adapter expects consumers to register Angular component classes (not React components) in `fieldRegistry` when using the Angular runtime.
+- The package exports a `DynamicFieldKitModule` to simplify consumer imports, and also provides standalone components for more advanced composition.
+
+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/README.md

@@ -4,6 +4,62 @@ Lightweight Angular adapters for `@dynamic-field-kit/core`.
 
 This package mirrors the React package structure and exposes Angular components that integrate with the shared `fieldRegistry` from `@dynamic-field-kit/core`.
 
-Notes:
-- The Angular package expects Angular runtime (peer) and uses dynamic component creation to mount field renderers registered in the shared registry.
-- This is a minimal scaffold to enable Angular integration patterns similar to the React package.
+Quick overview
+- Exports a minimal Angular integration: `DynamicInput`, `FieldInput`, `MultiFieldInput`, layout components and `DynamicFieldKitModule` (see `src/public-api.ts`).
+- Designed for local development (source import) and can be packaged with `ng-packagr` for distribution.
+
+Usage (consumer Angular app)
+
+1. Install the package (recommended: use packaged artifact or local `file:` during development):
+
+```bash
+# from your Angular app
+npm install @dynamic-field-kit/core @dynamic-field-kit/angular
+```
+
+2. Import the module in your `AppModule`:
+
+```ts
+import { DynamicFieldKitModule } from '@dynamic-field-kit/angular'
+
+@NgModule({
+	imports: [BrowserModule, DynamicFieldKitModule],
+})
+export class AppModule {}
+```
+
+3. Register Angular component classes into the shared registry at app startup (example):
+
+```ts
+// src/main.ts
+import '@dynamic-field-kit/angular/src/examples' // registers example component into fieldRegistry
+```
+
+Then use the Angular adapter components (`dfk-multi-field-input`, etc.) in templates.
+
+Local development
+- You can import the package source directly in your Angular app using `file:` references in `package.json` (see `example/angular-instructions.md` and `example/angular-app/` for a scaffold).
+
+Build & publish
+- This package supports `ng-packagr`. To build locally:
+
+```bash
+cd packages/angular
+npm install --no-audit --no-fund --save-dev ng-packagr rimraf
+npm run build
+```
+
+- To publish to npm (scoped package), ensure `publishConfig.access` is `public` and run:
+
+```bash
+cd packages/angular
+npm publish --access public
+```
+
+Notes & caveats
+- The Angular adapter expects consumers to register Angular component classes (not React components) in `fieldRegistry` when using the Angular runtime.
+- The package exports a `DynamicFieldKitModule` to simplify consumer imports, and also provides standalone components for more advanced composition.
+
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-field-kit/angular",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": false,
   "main": "dist/bundles/dynamic-field-kit-angular.umd.js",
   "module": "dist/fesm2015/dynamic-field-kit-angular.js",
@@ -29,5 +29,14 @@
   "devDependencies": {
     "ng-packagr": "^21.1.0",
     "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"
+  ]
 }