remove functions

README.md

@@ -55,55 +55,7 @@ class User {
   @Description('Account creation timestamp')
   createdAt!: Date;
 }
-
-// Use metadata in your application
-const content = `
-<h2>Edit ${label(User)}</h2>
-<div>${description(User)}</div>
-<form class="${tokens(User)}">
-  <label for="fullName">${label(User, 'fullName')}</label>
-  <input type="text" id="fullName" name="fullName" />
-
-  <label for="email">${label(User, 'email')}</label>
-  <input type="email" id="email" name="email" />
-</form>
-`;
 ```
-
----
-
-## 🔧 Functions
-
-### `description(target, property?, index?)`
-Retrieves the description metadata for a class, property, or parameter.
-
-### `name(target, property?, index?)`
-Retrieves the name metadata for a class, property, or parameter.
-
-### `label(target, property?, index?)`
-Retrieves the label metadata for a class, property, or parameter.
-
-### `sensitive(target, property?, index?)`
-Checks if a class, property, or parameter is marked as sensitive.
-
-### `token(target, property?, index?)`
-Retrieves the token metadata for a class, property, or parameter.
-
-### `noun(target, property?, index?)`
-Retrieves the noun metadata for a class, property, or parameter.
-
-### `example(target, property?, index?)`
-Retrieves the example metadata for a class, property, or parameter.
-
-### `labels(target, property?, index?)`
-Retrieves the plural label for a class, property, or parameter.
-
-### `tokens(target, property?, index?)`
-Retrieves the plural token for a class, property, or parameter.
-
-### `nouns(target, property?, index?)`
-Retrieves the plural noun for a class, property, or parameter.
-
 ---
 
 ## 🏗️ MetadataDescriptor
@@ -114,28 +66,6 @@ Creates or retrieves a metadata descriptor for a class, property, or parameter.
 ### `MetadataDescriptor.get(target, property?, index?)`
 Retrieves an existing metadata descriptor for a class, property, or parameter.
 
-### Example
-```ts
-import { MetadataDescriptor } from '@agape/metadata';
-
-// Get descriptor for a property
-const descriptor = MetadataDescriptor.for(User, 'email');
-
-// Access all metadata properties
-console.log(descriptor.description);  // "The user's email address..."
-console.log(descriptor.label);        // "Email Address"
-console.log(descriptor.name);         // "email"
-console.log(descriptor.sensitive);    // true
-console.log(descriptor.token);        // "user.email"
-console.log(descriptor.noun);         // "email"
-console.log(descriptor.nouns);        // "emails"
-console.log(descriptor.example);      // "john.doe@example.com"
-
-// Set metadata directly
-descriptor.description = "Updated description";
-descriptor.sensitive = false;
-```
-
 ---
 
 ## 📚 Documentation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agape/metadata",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Metadata annotations",
   "main": "./cjs/index.js",
   "module": "./es2020/index.js",

src/index.ts

@@ -6,13 +6,3 @@ export * from './lib/decorators/noun.decorator';
 export * from './lib/decorators/sensitive.decorator';
 export * from './lib/decorators/token.decorator';
 export * from './lib/descriptors/metadata.descriptor';
-export * from './lib/functions/description';
-export * from './lib/functions/example';
-export * from './lib/functions/label';
-export * from './lib/functions/labels';
-export * from './lib/functions/name';
-export * from './lib/functions/noun';
-export * from './lib/functions/nouns';
-export * from './lib/functions/sensitive';
-export * from './lib/functions/token';
-export * from './lib/functions/tokens';

src/lib/decorators/label.decorator.spec.ts

@@ -59,6 +59,6 @@ describe('Label', () => {
     }
 
     const d = MetadataDescriptor.for(Foo)
-    expect(d.labels).toBe('Foos')
+    expect(d.labelPlural).toBe('Foos')
   })
 })

src/lib/decorators/label.decorator.ts

@@ -8,7 +8,7 @@ import { MetadataDescriptor } from '../descriptors/metadata.descriptor';
  * Labels can be used when displaying in user interfaces such as form inputs,
  * tables, and auto-generated documentation.
  *
- * > This decorator sets the `<property>label` and `<property>labels` properties
+ * > This decorator sets the `<property>label` and `<property>labelPlural` properties
  * on the associated {@link MetadataDescriptor}.
  *
  * @example
@@ -69,7 +69,7 @@ export function Label(...args: any[]) {
 
     descriptor.label = args[0];
 
-    if (args.length > 1) descriptor.labels = args[1];
+    if (args.length > 1) descriptor.labelPlural = args[1];
   }
 
   return Label

src/lib/decorators/noun.decorator.spec.ts

@@ -59,6 +59,6 @@ describe('Noun', () => {
     }
 
     const d = MetadataDescriptor.for(Foo)
-    expect(d.nouns).toBe('foos')
+    expect(d.nounPlural).toBe('foos')
   })
 })

src/lib/decorators/noun.decorator.ts

@@ -7,7 +7,7 @@ import { MetadataDescriptor } from '../descriptors/metadata.descriptor';
  *
  * Nouns can be used when referencing the object or attribute.
  *
- * > This decorator sets the `<property>noun` and `<property>nouns` properties
+ * > This decorator sets the `<property>noun` and `<property>nounPlural` properties
  * on the associated {@link MetadataDescriptor}.
  *
  * @example
@@ -68,7 +68,7 @@ export function Noun(...args: any[]) {
 
     descriptor.noun = args[0];
 
-    if (args.length > 1) descriptor.nouns = args[1];
+    if (args.length > 1) descriptor.nounPlural = args[1];
   }
 
   return Noun

src/lib/descriptors/metadata.descriptor.spec.ts

@@ -15,9 +15,9 @@ describe('MetadataDescriptor', () => {
   it('should set some properties', () => {
     d = new MetadataDescriptor('TestName');
     d.label = 'Label';
-    d.labels = 'Labels';
+    d.labelPlural = 'Labels';
     d.noun = 'noun';
-    d.nouns = 'nouns';
+    d.nounPlural = 'nouns';
     d.token = 'token';
     d.tokens = 'tokens';
     d.sensitive = true;
@@ -26,9 +26,9 @@ describe('MetadataDescriptor', () => {
 
     expect(d.name).toEqual('TestName');
     expect(d.label).toEqual('Label');
-    expect(d.labels).toEqual('Labels');
+    expect(d.labelPlural).toEqual('Labels');
     expect(d.noun).toEqual('noun');
-    expect(d.nouns).toEqual('nouns');
+    expect(d.nounPlural).toEqual('nouns');
     expect(d.token).toEqual('token');
     expect(d.tokens).toEqual('tokens');
     expect(d.sensitive).toEqual(true);

src/lib/descriptors/metadata.descriptor.ts

@@ -6,7 +6,7 @@ import 'reflect-metadata';
  * A descriptor that holds metadata information for classes, properties, methods, and parameters.
  *
  * The `MetadataDescriptor` class is used to store and retrieve metadata associated with various
- * elements in your codebase. It supports storing information like names, labels, descriptions,
+ * elements in your codebase. It supports storing information like names, labelPlural, descriptions,
  * and other metadata that can be used for serialization, validation, documentation generation,
  * and other metadata-driven operations.
  *
@@ -39,7 +39,7 @@ import 'reflect-metadata';
  *
  * @example
  * ### Example
- * 
+ *
  * ```ts
  * class User {
  *   @Label('Email address')
@@ -86,7 +86,7 @@ export class MetadataDescriptor {
    * Used when displaying multiple instances of the decorated element,
    * such as in table headers or list titles.
    */
-  labels?: string;
+  labelPlural?: string;
 
   /**
    * A noun that represents the decorated element.
@@ -101,7 +101,7 @@ export class MetadataDescriptor {
    *
    * Used when referring to multiple instances of the decorated element.
    */
-  nouns?: string;
+  nounPlural?: string;
 
   /**
    * A token identifier for the decorated element.