Redesign meta

CHANGELOG.md

@@ -7,10 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* `hasMeta()` util, in `@aedart/support/meta`. 
+* `MetaRepository`, `TargetMetaRepository`, `TargetContext`, `Entry`, and `hasTargetMeta()` in `@aedart/support/meta`.
+* `ClassDecorator`, `ClassMethodDecorator`, `ClassGetterDecorator`, `ClassSetterDecorator`, `ClassFieldDecorator`, `ClassAutoAccessorDecorator`, and `Decorator` types, in `@aedart/contracts`.
+* `ClassDecoratorResult`, `ClassMethodDecoratorResult`, `ClassGetterDecoratorResult`, `ClassSetterDecoratorResult`, `ClassFieldDecoratorResult`, `ClassAutoAccessorDecoratorResult`, and `DecoratorResult` types, in `@aedart/contracts`.
+
+### Changed
+
+**Breaking**
+
+* `targetMeta()` and `inheritTargetMeta()` now throw `MetaError` (_`TypeError` was previously thrown_), in `@aedart/support/meta`.
+
+**Non-breaking Changes**
+
+* Refactored / Redesigned `meta()`, `getMeta()`, and `getAllMeta()` to use new `MetaRepository` as its underlying core component for dealing with metadata.
+* Refactored / Redesigned `targetMeta()`, `getTargetMeta()`, and `inheritTargetMeta()` to use new `TargetMetaRepository` underneath.
+* Return type of `meta()` changed to `Decorator`.
+* `MetaTargetContext` expanded with a `context: Context` property. `@aedart/contracts/support/meta`.
+
 ### Fixed
 
 * Broken links in support/exceptions and in support/objects docs. 
 
+### Removed
+
+* `ClassContext`, `MethodContext`, `GetterContext`, `SetterContext`, `FieldContext`, `AccessorContext` and `MetadataContext`, in `@aedart/contracts/support/meta` (_components were deprecated in `v0.7.0`_).
+* `MemberContext` type in `@aedart/contracts/support/meta` (_type was deprecated in `v0.7.0`_).
+
 ## [0.9.0] - 2024-03-05
 
 ### Added

packages/contracts/src/decorators.ts

@@ -0,0 +1,93 @@
+/**
+ * Class Decorator Result
+ */
+export type ClassDecoratorResult = object | void;
+
+/**
+ * Class Method Decorator Result
+ */
+export type ClassMethodDecoratorResult = object | void;
+
+/**
+ * Class Getter Decorator Result
+ */
+export type ClassGetterDecoratorResult = object | void;
+
+/**
+ * Class Setter Decorator Result
+ */
+export type ClassSetterDecoratorResult = object | void;
+
+/**
+ * Class Field Decorator Result
+ */
+export type ClassFieldDecoratorResult = (initialValue: unknown) => unknown | void;
+
+/**
+ * Class Auto-Accessor Decorator Result
+ */
+export type ClassAutoAccessorDecoratorResult = ClassAccessorDecoratorResult<object, unknown> | void
+
+/**
+ * Decorator Result
+ */
+export type DecoratorResult = ClassDecoratorResult
+    | ClassMethodDecoratorResult
+    | ClassGetterDecoratorResult
+    | ClassSetterDecoratorResult
+    | ClassFieldDecoratorResult
+    | ClassAutoAccessorDecoratorResult;
+
+/**
+ * Class Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassDecorator = (target: object, context: ClassDecoratorContext) => ClassDecoratorResult;
+
+/**
+ * Class Method Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassMethodDecorator = (target: object, context: ClassMethodDecoratorContext) => ClassMethodDecoratorResult;
+
+/**
+ * Class Getter Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassGetterDecorator = (target: object, context: ClassGetterDecoratorContext) => ClassGetterDecoratorResult;
+
+/**
+ * Class Setter Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassSetterDecorator = (target: object, context: ClassSetterDecoratorContext) => ClassSetterDecoratorResult;
+
+/**
+ * Class Field Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassFieldDecorator = (target: object, context: ClassFieldDecoratorContext) => ClassFieldDecoratorResult;
+
+/**
+ * Class Auto-Accessor Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type ClassAutoAccessorDecorator = (target: ClassAccessorDecoratorTarget<object, unknown>, context: ClassAccessorDecoratorContext) => ClassAutoAccessorDecoratorResult;
+
+/**
+ * Decorator
+ *
+ * @see https://github.com/tc39/proposal-decorators
+ */
+export type Decorator = ClassDecorator
+    | ClassMethodDecorator
+    | ClassGetterDecorator
+    | ClassSetterDecorator
+    | ClassFieldDecorator
+    | ClassAutoAccessorDecorator;

packages/contracts/src/support/meta/MetaEntry.ts

@@ -10,12 +10,12 @@ export default interface MetaEntry
      * 
      * @type {Key}
      */
-    key: Key,
+    key: Key;
 
     /**
      * Value to store
      * 
      * @type {unknown}
      */
-    value: unknown
+    value: unknown;
 }

packages/contracts/src/support/meta/MetaTargetContext.ts

@@ -1,20 +1,35 @@
+import { Context } from './types';
+
 /**
  * Meta Decorator Target Context
  */
 export default interface MetaTargetContext
 {
     /**
      * The class that owns the meta
+     * 
+     * @type {object}
      */
-    owner: object,
+    owner: object;
 
     /**
      * "This" argument
+     *
+     * @type {any}
      */
-    thisArg: any, /* eslint-disable-line @typescript-eslint/no-explicit-any */
+    thisArg: any; /* eslint-disable-line @typescript-eslint/no-explicit-any */
 
     /**
      * The target class, field, method... that is being decorated
+     *
+     * @type {object}
+     */
+    target: object;
+
+    /**
+     * Decorator context
+     *
+     * @type {Context}
      */
-    target: object,
+    context: Context;
 }

packages/contracts/src/support/meta/Repository.ts

@@ -0,0 +1,67 @@
+import { DecoratorResult } from "@aedart/contracts";
+import { Key } from "@aedart/contracts/support";
+import { Context, MetaCallback, MetadataRecord } from "./types";
+
+/**
+ * Meta Repository
+ */
+export default interface Repository
+{
+    /**
+     * The owner class
+     * 
+     * @type {object}
+     */
+    readonly owner: object;
+
+    /**
+     * Set value for given key
+     * 
+     * **Caution**: _Method is intended to be invoked inside a decorator!_
+     * 
+     * @param {object} target Decorator target, e.g. class, field, method...etc
+     * @param {Context} context
+     * @param {Key | MetaCallback} key
+     * @param {any} [value] Value to be stored. Ignored if `key` argument is a callback.
+     * 
+     * @return {DecoratorResult}
+     */
+    set(
+        target: object,
+        context: Context,
+        key: Key | MetaCallback,
+        value?: any /* eslint-disable-line @typescript-eslint/no-explicit-any */
+    ): DecoratorResult;
+
+    /**
+     * Get value for given key
+     * 
+     * @template T Return value type
+     * @template D=any Type of default value
+     * 
+     * @param {Key} key
+     * @param {D} [defaultValue]
+     * 
+     * @return {T | D | undefined}
+     */
+    get<
+        T,
+        D = any /* eslint-disable-line @typescript-eslint/no-explicit-any */
+    >(key: Key, defaultValue?: D): T | D | undefined;
+
+    /**
+     * Determine if value exists for key
+     * 
+     * @param {Key} key
+     * 
+     * @return {boolean}
+     */
+    has(key: Key): boolean;
+
+    /**
+     * Get all metadata
+     * 
+     * @return {MetadataRecord}
+     */
+    all(): MetadataRecord;
+}