ag-studio-angular 0.0.1 → 1.0.1

package/lib/ag-studio.component.d.ts

@@ -0,0 +1,154 @@
+import { AfterViewInit, ElementRef, EventEmitter, OnChanges, OnDestroy } from '@angular/core';
+import type { AgStudioApi, AgStudioModule, AgStudioProperties } from 'ag-studio';
+import type { AgAiAssistant, AgDataEngine, AgDataSourcesDefinition, AgPageLayoutState, AgPanelConfig, AgReportState, AgStudioApiReadyEvent, AgStudioErrorRaisedEvent, AgStudioGetLocaleTextParams, AgStudioLocaleText, AgStudioMode, AgStudioOverrides, AgStudioReadyEvent, AgStudioStateUpdatedEvent, AgStudioTheme } from 'ag-studio';
+import { AngularFrameworkOverrides } from './angularFrameworkOverrides';
+import * as i0 from "@angular/core";
+export declare class AgStudio implements AfterViewInit, OnChanges, OnDestroy {
+    private readonly _angularFrameworkOverrides;
+    private readonly _nativeElement;
+    private _initialised;
+    private _destroyed;
+    private _holdEvents;
+    private _resolveFullyReady;
+    private readonly _fullyReady;
+    /** Dash Api available after onApiReady event has fired. */
+    api: AgStudioApi;
+    constructor(elementDef: ElementRef, _angularFrameworkOverrides: AngularFrameworkOverrides);
+    ngAfterViewInit(): void;
+    ngOnChanges(changes: any): void;
+    ngOnDestroy(): void;
+    protected isEmitterUsed(eventType: string): boolean;
+    private globalListener;
+    /** Provided an initial studioProperties configuration to the component. If a property is specified in both studioProperties and via component binding the component binding takes precedence.  */
+    studioProperties: AgStudioProperties | undefined;
+    /**
+     * Used to register AG Studio Modules directly with this instance of Studio.
+     */
+    modules: AgStudioModule[] | undefined;
+    /** Change this value to set the tabIndex order of Studio within your application.
+     * @default 0
+     * @initial
+     */
+    tabIndex: number | undefined;
+    /** Set to `true` to operate Studio in RTL (Right to Left) mode.
+     * @default false
+     * @initial
+     */
+    enableRtl: boolean | undefined;
+    /** DOM element to use as the popup parent for Studio popups (context menus, etc.).
+     */
+    popupParent: HTMLElement | null | undefined;
+    /** Theme to apply to Studio.
+     *
+     * @default studioTheme
+     */
+    theme: AgStudioTheme | undefined;
+    /** If your theme uses a font that is available on Google Fonts, pass true to load it from Google's CDN.
+     */
+    loadThemeGoogleFonts: boolean | undefined;
+    /** The CSS layer that this theme should be rendered onto. When specified,
+     * Studio CSS will be wrapped in a `@layer ${themeCssLayer} { ... }` block.
+     *
+     * NOTE: when specifying `themeCssLayer` we recommend setting
+     * `themeStyleContainer` to `document.body` to ensure that Studio CSS
+     * comes after your application CSS, allowing your application to set the
+     * order of layers.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/CSS/@layer
+     */
+    themeCssLayer: string | undefined;
+    /** The nonce attribute to set on style elements added to the document by
+     * themes. If "foo" is passed to this property, Studio can use the Content
+     * Security Policy `style-src 'nonce-foo'`, instead of the less secure
+     * `style-src 'unsafe-inline'`.
+     *
+     * Note: CSP nonces are global to a page, where a page has multiple Studio components,
+     * every one must have the same styleNonce set.
+     */
+    styleNonce: string | undefined;
+    /** An element to insert style elements into when injecting styles into the
+     * Studio. Styles are inserted at the start of the element.
+     *
+     * If undefined, styles will be added to the document head for Studio components
+     * rendered in the main document fragment, or to Studio wrapper element
+     * for other Studio components (e.g. those rendered in a shadow DOM or detached from the
+     * document).
+     *
+     * @initial
+     */
+    themeStyleContainer: (HTMLElement | (() => HTMLElement | void)) | undefined;
+    /** Allows overriding what `document` is used.
+     * Use this when you want Studio to use a different `document` than the one available on the global scope.
+     * This can happen if docking out components (something which Electron supports).
+     */
+    getDocument: (() => Document) | undefined;
+    /** Disables touch support (but does not remove the browser's efforts to simulate mouse events on touch).
+     * @default false
+     * @initial
+     */
+    suppressTouch: boolean | undefined;
+    /** A map of key->value pairs for localising text within Studio.
+     * @initial
+     */
+    localeText: AgStudioLocaleText | undefined;
+    /** A callback for localising text within Studio.
+     * @initial
+     */
+    getLocaleText: ((params: AgStudioGetLocaleTextParams) => string) | undefined;
+    /** Provide a custom `studioId` for this instance of Studio. Value will be set on the root DOM node using the attribute `studio-id` as well as being accessible via the `api.getStudioId()` method.
+     * @initial
+     */
+    studioId: string | undefined;
+    /** Provides a context object that is provided to different callbacks Studio uses. Used for passing additional information to the callbacks used by your application.
+     * @initial
+     */
+    context: any;
+    /** Initial state for Studio. Only read once on initialization. Can be used in conjunction with `api.getState()` to save and restore Studio state.
+     * @initial
+     */
+    initialState: AgReportState | undefined;
+    /** Defines the data sources used by Studio.
+     *
+     * If updated after initially being set, only changes to synchronous data will be processed.
+     * Any other changes will be ignored (e.g. adding/removing data sources, updating fields, etc.)
+     */
+    data: AgDataSourcesDefinition | AgDataEngine | undefined;
+    /** Which mode Studio is in.
+     * @default 'view'
+     */
+    mode: AgStudioMode | undefined;
+    /** Default layout styling.
+     */
+    layout: Partial<AgPageLayoutState> | undefined;
+    /** AI Assistant configuration.
+     *
+     * NOTE: The     **AI Assistant** is an experimental feature. Behaviour will be
+     * slightly different depending on the LLM being used, and results can vary across queries.
+     *
+     * @initial
+     */
+    ai: AgAiAssistant | undefined;
+    /** Overrides for the layout and widget configs.
+     */
+    overrides: AgStudioOverrides | undefined;
+    /** Configure which panels are displayed and on which side.
+     */
+    panels: AgPanelConfig | undefined;
+    /** State has been updated.
+     */
+    stateUpdated: EventEmitter<AgStudioStateUpdatedEvent>;
+    /** The API has been initialised and is ready for most calls. The data engine has not been initialised yet, and the UI is not ready.
+     */
+    apiReady: EventEmitter<AgStudioApiReadyEvent>;
+    /** The data engine has been initialised, and the UI has been created, but may not be fully rendered yet.
+     */
+    studioReady: EventEmitter<AgStudioReadyEvent>;
+    /** An error has occurred within Studio.
+     */
+    errorRaised: EventEmitter<AgStudioErrorRaisedEvent>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AgStudio, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AgStudio, "ag-studio", never, { "studioProperties": { "alias": "studioProperties"; "required": false; }; "modules": { "alias": "modules"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "enableRtl": { "alias": "enableRtl"; "required": false; }; "popupParent": { "alias": "popupParent"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; "loadThemeGoogleFonts": { "alias": "loadThemeGoogleFonts"; "required": false; }; "themeCssLayer": { "alias": "themeCssLayer"; "required": false; }; "styleNonce": { "alias": "styleNonce"; "required": false; }; "themeStyleContainer": { "alias": "themeStyleContainer"; "required": false; }; "getDocument": { "alias": "getDocument"; "required": false; }; "suppressTouch": { "alias": "suppressTouch"; "required": false; }; "localeText": { "alias": "localeText"; "required": false; }; "getLocaleText": { "alias": "getLocaleText"; "required": false; }; "studioId": { "alias": "studioId"; "required": false; }; "context": { "alias": "context"; "required": false; }; "initialState": { "alias": "initialState"; "required": false; }; "data": { "alias": "data"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; "ai": { "alias": "ai"; "required": false; }; "overrides": { "alias": "overrides"; "required": false; }; "panels": { "alias": "panels"; "required": false; }; }, { "stateUpdated": "stateUpdated"; "apiReady": "apiReady"; "studioReady": "studioReady"; "errorRaised": "errorRaised"; }, never, never, true, never>;
+    static ngAcceptInputType_enableRtl: unknown;
+    static ngAcceptInputType_loadThemeGoogleFonts: unknown;
+    static ngAcceptInputType_suppressTouch: unknown;
+}

package/lib/ag-studio.module.d.ts

@@ -0,0 +1,7 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./ag-studio.component";
+export declare class AgStudioModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AgStudioModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AgStudioModule, never, [typeof i1.AgStudio], [typeof i1.AgStudio]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AgStudioModule>;
+}

package/lib/angularFrameworkOverrides.d.ts

@@ -0,0 +1,28 @@
+import { NgZone } from '@angular/core';
+import { _VanillaFrameworkOverrides } from 'ag-studio';
+import type { FrameworkOverridesIncomingSource } from 'ag-grid-enterprise';
+import * as i0 from "@angular/core";
+export declare class AngularFrameworkOverrides extends _VanillaFrameworkOverrides {
+    private readonly _ngZone;
+    readonly batchFrameworkComps: boolean;
+    private readonly isRunningWithinTestZone;
+    private readonly runOutside;
+    constructor(_ngZone: NgZone);
+    wrapIncoming: <T>(callback: () => T, source?: FrameworkOverridesIncomingSource) => T;
+    /**
+     * The shouldWrapOutgoing property is used to determine if events should be run outside of Angular or not.
+     * If an event handler is registered outside of Angular then we should not wrap the event handler
+     * with runInsideAngular() as the user may not have wanted this.
+     * This is also used to not wrap internal event listeners that are registered with RowNodes and Columns.
+     */
+    get shouldWrapOutgoing(): boolean;
+    /**
+     * Make sure that any code that is executed outside of AG Studio is running within the Angular zone.
+     * This means users can update templates and use binding without having to do anything extra.
+     */
+    wrapOutgoing: <T>(callback: () => T) => T;
+    runInsideAngular<T>(callback: () => T): T;
+    runOutsideAngular<T>(callback: () => T, source?: FrameworkOverridesIncomingSource): T;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AngularFrameworkOverrides, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AngularFrameworkOverrides>;
+}

package/package.json

@@ -1,20 +1,32 @@
 {
   "name": "ag-studio-angular",
-  "version": "0.0.1",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "Sean Landsman <sean@thelandsmans.com>",
+  "version": "1.0.1",
+  "description": "AG Studio Angular Component",
   "license": "Commercial",
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not ie >= 0",
-    "not ie_mob >= 0",
-    "not blackberry > 0"
-  ],
-  "homepage": "https://www.ag-grid.com/",
-  "description": ""
-}
+  "peerDependencies": {
+    "@angular/common": ">= 18.0.0",
+    "@angular/core": ">= 18.0.0"
+  },
+  "dependencies": {
+    "ag-studio": "1.0.1",
+    "tslib": "^2.3.0"
+  },
+  "bugs": {
+    "url": "https://ag-grid.zendesk.com/"
+  },
+  "homepage": "https://www.ag-grid.com/studio/",
+  "module": "fesm2022/ag-studio-angular.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/ag-studio-angular.mjs",
+      "esm": "./esm2022/ag-studio-angular.mjs",
+      "default": "./fesm2022/ag-studio-angular.mjs"
+    }
+  },
+  "sideEffects": false
+}

package/public-api.d.ts

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

package/index.js

@@ -1 +0,0 @@
-console.log("Hello World");