@harnessio/yaml-editor 0.13.0 → 0.15.0-beta-1

package/README.md

@@ -1 +1,29 @@
 # Yaml Editor
+
+## Development
+
+Run `pnpm dev` and `pnpm playground`
+
+## Playground
+
+`pnpm playground`
+
+## Production
+
+`pnpm build`
+
+## Setup
+
+```tsx
+import { ILanguageFeaturesService } from 'monaco-editor/esm/vs/editor/common/services/languageFeatures.js'
+import { OutlineModel } from 'monaco-editor/esm/vs/editor/contrib/documentSymbols/browser/outlineModel.js'
+import { StandaloneServices } from 'monaco-editor/esm/vs/editor/standalone/browser/standaloneServices.js'
+
+import { MonacoGlobals } from '@harnessio/yaml-editor'
+
+MonacoGlobals.set({
+  ILanguageFeaturesService,
+  OutlineModel,
+  StandaloneServices
+})
+```

package/dist/components/BlameEditor.d.ts

@@ -1,7 +1,9 @@
+import { EditorProps } from '@monaco-editor/react';
 import { BlameItem } from '../types/blame';
 import { ThemeDefinition } from '../types/themes';
 
-export interface BlameEditorProps<_> {
+import * as monaco from 'monaco-editor';
+export interface BlameEditorProps {
     code: string;
     language: string;
     themeConfig?: {
@@ -13,5 +15,7 @@ export interface BlameEditorProps<_> {
     lineNumbersPosition?: 'left' | 'center';
     blameData: BlameItem[];
     showSeparators?: boolean;
+    height?: EditorProps['height'];
+    options?: monaco.editor.IStandaloneEditorConstructionOptions;
 }
-export declare function BlameEditor<T>(props: BlameEditorProps<T>): JSX.Element;
+export declare function BlameEditor({ code, language, themeConfig, lineNumbersPosition, blameData, showSeparators, theme: themeFromProps, height, options }: BlameEditorProps): JSX.Element;

package/dist/components/CodeEditor.d.ts

@@ -1,5 +1,6 @@
+import { EditorProps } from '@monaco-editor/react';
 import { ThemeDefinition } from '../types/themes';
-/// <reference types="react" />
+
 import * as monaco from 'monaco-editor';
 export interface CodeRevision {
     code: string;
@@ -15,8 +16,7 @@ export interface CodeEditorProps<_> {
         themes?: ThemeDefinition[];
     };
     theme?: string;
-    options?: {
-        readOnly?: boolean;
-    };
+    options?: monaco.editor.IStandaloneEditorConstructionOptions;
+    height?: EditorProps['height'];
 }
-export declare function CodeEditor<T>(props: CodeEditorProps<T>): JSX.Element;
+export declare function CodeEditor<T>({ codeRevision, onCodeRevisionChange, language, themeConfig, options, theme: themeFromProps, height }: CodeEditorProps<T>): JSX.Element;

package/dist/components/DiffEditor.d.ts

@@ -1,5 +1,7 @@
+import { EditorProps } from '@monaco-editor/react';
 import { ThemeDefinition } from '../types/themes';
 
+import * as monaco from 'monaco-editor';
 export interface CodeRevision {
     code: string;
     revisionId?: number;
@@ -14,8 +16,7 @@ export interface DiffEditorProps<_> {
         themes?: ThemeDefinition[];
     };
     theme?: string;
-    options?: {
-        readOnly?: boolean;
-    };
+    options?: monaco.editor.IStandaloneEditorConstructionOptions;
+    height?: EditorProps['height'];
 }
-export declare function CodeDiffEditor<T>(props: DiffEditorProps<T>): JSX.Element;
+export declare function CodeDiffEditor<T>({ original, modified, language, themeConfig, options, theme: themeFromProps, height }: DiffEditorProps<T>): JSX.Element;

package/dist/components/YamlEditor.d.ts

@@ -1,7 +1,6 @@
 import { InlineAction } from '../types/inline-actions';
 import { PathSelector } from '../types/selectors';
 import { ThemeDefinition } from '../types/themes';
-/// <reference types="react" />
 import * as monaco from 'monaco-editor';
 export interface YamlRevision {
     yaml: string;
@@ -24,10 +23,13 @@ export interface YamlEditorProps<T> {
         themes?: ThemeDefinition[];
     };
     theme?: string;
+    options?: monaco.editor.IStandaloneEditorConstructionOptions;
     selection?: {
         path: string;
         className: string;
         revealInCenter?: boolean;
     };
+    animateOnUpdate?: boolean;
+    onAnimateEnd?: () => void;
 }
-export declare function YamlEditor<T>(props: YamlEditorProps<T>): JSX.Element;
+export declare const YamlEditor: <T>(props: YamlEditorProps<T>) => JSX.Element;

package/dist/components/YamlProvider.d.ts

@@ -11,5 +11,5 @@ export interface YamlEditorContextInterface {
     }) => void;
 }
 export declare const YamlEditorContext: import('react').Context<YamlEditorContextInterface>;
-export declare function YamlEditorContextProvider({ children }: React.PropsWithChildren): React.ReactElement;
+export declare function YamlEditorContextProvider({ children }: React.PropsWithChildren<React.HTMLAttributes<HTMLElement>>): React.ReactElement;
 export declare function useYamlEditorContext(): YamlEditorContextInterface;

package/dist/constants/monaco-common-default-options.d.ts

@@ -0,0 +1,2 @@
+import * as monaco from 'monaco-editor';
+export declare const MonacoCommonDefaultOptions: monaco.editor.IStandaloneDiffEditorConstructionOptions;