ag-studio-angular 1.0.0 → 1.1.0

package/lib/angularFrameworkOverrides.d.ts

@@ -21,6 +21,7 @@ export declare class AngularFrameworkOverrides extends _VanillaFrameworkOverride
      * This means users can update templates and use binding without having to do anything extra.
      */
     wrapOutgoing: <T>(callback: () => T) => T;
+    isFrameworkComponent(comp: any): boolean;
     runInsideAngular<T>(callback: () => T): T;
     runOutsideAngular<T>(callback: () => T, source?: FrameworkOverridesIncomingSource): T;
     static ɵfac: i0.ɵɵFactoryDeclaration<AngularFrameworkOverrides, never>;

package/lib/interfaces.d.ts

@@ -0,0 +1,31 @@
+import type { Type } from '@angular/core';
+import type { AgBaseRegistry, AgBaseWidgetDefinition, AgDefaultWidgetType, AgMaybePromise, AgTypeScriptComponent, AgWidgetData, AgWidgetDataFormat, AgWidgetParams, AgWidgetRegistry } from 'ag-studio';
+export interface AgCustomComponent<TParams, TReturn = void> {
+    /** Called once on initialisation with params for rendering this component. */
+    agInit(params: TParams): AgMaybePromise<TReturn>;
+    /** Called for every subsequent params update. */
+    refresh?(params: TParams): AgMaybePromise<TReturn>;
+}
+export interface AgWidgetDefinition<TWidgetType extends string = string, TIn extends AgWidgetData<unknown, AgWidgetDataFormat<unknown>> = any, TOut extends AgWidgetData<unknown, AgWidgetDataFormat<unknown>> = TIn, TOptions = unknown> extends AgBaseWidgetDefinition<TWidgetType, TIn, TOut, TOptions> {
+    /**
+     * Custom component. Either:
+     * - A `string` that matches a custom component in the studio `components` property
+     * - A custom Angular component class
+     * - A custom TypeScript component (no Angular; working directly with the DOM)
+     */
+    comp: string | Type<AgCustomComponent<AgWidgetParams<TOut>>> | (new () => AgTypeScriptComponent<AgWidgetParams<TOut>>);
+}
+type StringCompWidgetType<TDef extends AgBaseWidgetDefinition> = TDef['comp'] extends string ? TDef : never;
+type ExtractStateFromDef<TDef> = TDef extends AgWidgetDefinition<any, any, infer TState> ? TState : never;
+type MatchingDef<TDef, TWidgetType> = TDef extends {
+    id: TWidgetType;
+} ? TDef : never;
+type WidgetCustomComp<TParams extends AgWidgetParams> = Type<AgCustomComponent<TParams>> | (new () => AgTypeScriptComponent<TParams>);
+export type AgCustomComponentDefs<TRegistry extends AgBaseRegistry> = {
+    [K in Exclude<StringCompWidgetType<AgWidgetRegistry<TRegistry>>['comp'], AgDefaultWidgetType>]?: WidgetCustomComp<AgWidgetParams<ExtractStateFromDef<MatchingDef<AgWidgetRegistry<TRegistry>, K>>>>;
+};
+export interface AgRegistry extends AgBaseRegistry {
+    widgets: readonly AgWidgetDefinition[];
+    components: AgCustomComponentDefs<this>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ag-studio-angular",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "AG Studio Angular Component",
   "license": "Commercial",
   "peerDependencies": {
@@ -8,7 +8,7 @@
     "@angular/core": ">= 18.0.0"
   },
   "dependencies": {
-    "ag-studio": "1.0.0",
+    "ag-studio": "1.1.0",
     "tslib": "^2.3.0"
   },
   "bugs": {

package/public-api.d.ts

@@ -1,3 +1,5 @@
 export * from './lib/ag-studio.component';
 export * from './lib/ag-studio.module';
 export * from './lib/angularFrameworkOverrides';
+export * from './lib/angularFrameworkComponentWrapper';
+export * from './lib/interfaces';