feat(preset-loader): add the possibility to not show local preset and…

… create one from a ncr oas endpoint response (#33) Co-authored-by: Puria Nafisi Azizi <[email protected]>
dyne · Dec 23, 2024 · 670fc54 · 670fc54
1 parent ca0ef66
commit 670fc54
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 6 deletions.
diff --git a/src/components.d.ts b/src/components.d.ts
@@ -59,6 +59,8 @@ export namespace Components {
     }
     interface DyneSlangroomPresetLoader {
         "editorId": string;
+        "loadLocalPresets": boolean;
+        "oasEndpoint"?: string;
     }
 }
 declare global {
@@ -148,6 +150,8 @@ declare namespace LocalJSX {
     }
     interface DyneSlangroomPresetLoader {
         "editorId"?: string;
+        "loadLocalPresets"?: boolean;
+        "oasEndpoint"?: string;
     }
     interface IntrinsicElements {
         "dyne-button": DyneButton;

diff --git a/src/components/dyne-slangroom-preset-loader/dyne-slangroom-preset-loader.tsx b/src/components/dyne-slangroom-preset-loader/dyne-slangroom-preset-loader.tsx
@@ -13,10 +13,11 @@ export class DyneSlangroomPresetLoader {
   @Element() el: HTMLElement;
 
   @Prop({ reflect: true }) editorId: string;
+  @Prop() loadLocalPresets: boolean = true;
+  @Prop() oasEndpoint?: string;
 
-  @State() presets: SlangroomPreset[] = SlangroomPresets;
-
-  @State() filteredPresets: SlangroomPreset[] = this.presets;
+  @State() presets: SlangroomPreset[] = [];
+  @State() filteredPresets: SlangroomPreset[] = [];
   @State() searchText = '';
 
   get dialog() {
@@ -28,6 +29,13 @@ export class DyneSlangroomPresetLoader {
   }
 
   async componentDidLoad() {
+    if (this.loadLocalPresets) {
+      this.presets = SlangroomPresets;
+    }
+    if (this.oasEndpoint) {
+      const apiPresets = await this.fetchPresetsFromOas();
+      this.addPresets(apiPresets);
+    }
     await this.loadPresetsFromElements();
     lockScrollOnDialogOpen(this.dialog!);
   }
@@ -72,6 +80,43 @@ export class DyneSlangroomPresetLoader {
     this.presets = [...this.presets, ...presets];
   }
 
+  private async fetchPresetsFromOas(): Promise<SlangroomPreset[]> {
+    if (!this.oasEndpoint) return [];
+
+    try {
+      const response = await fetch(this.oasEndpoint);
+      if (!response.ok) {
+        console.error('Failed to fetch presets:', response.statusText);
+        return [];
+      }
+      const oas = await response.json();
+      const oasPaths: OasPaths = oas.paths;
+      const res: SlangroomPreset[] = [];
+      for (const [contractPath, contractMethods] of Object.entries(oasPaths)) {
+        if (contractPath.endsWith('/app') || contractPath.endsWith('/raw')) {
+          continue;
+        }
+        const contractInfo = contractMethods?.post || contractMethods?.get;
+        if (!contractInfo) continue;
+        res.push({
+          name: contractPath,
+          contract: contractInfo.description,
+          keys: contractInfo.keys,
+          data: '',
+          meta: {
+            title: contractPath,
+            highlight: ""
+          },
+          group: contractInfo.tags[0]
+        });
+      }
+      return res;
+    } catch (error) {
+      console.error('Error fetching presets:', error);
+      return [];
+    }
+  }
+
   @Watch('presets')
   updatePresetsSearch() {
     this.filteredPresets = this.presets;
@@ -142,6 +187,19 @@ type PresetsProps = {
   presets?: SlangroomPreset[];
 };
 
+type OasPathMethod = {
+  description: string;
+  keys: string;
+  tags: string[];
+};
+
+type OasPathValue = {
+  get?: OasPathMethod;
+  post?: OasPathMethod;
+};
+
+type OasPaths = Record<string, OasPathValue>;
+
 function PresetsSelect(props: PresetsProps) {
   const { onPresetSelect = () => {}, presets = [] } = props;
 

diff --git a/src/components/dyne-slangroom-preset-loader/readme.md b/src/components/dyne-slangroom-preset-loader/readme.md
@@ -7,9 +7,11 @@
 
 ## Properties
 
-| Property   | Attribute   | Description | Type     | Default     |
-| ---------- | ----------- | ----------- | -------- | ----------- |
-| `editorId` | `editor-id` |             | `string` | `undefined` |
+| Property           | Attribute            | Description | Type                  | Default     |
+| ------------------ | -------------------- | ----------- | --------------------- | ----------- |
+| `editorId`         | `editor-id`          |             | `string`              | `undefined` |
+| `loadLocalPresets` | `load-local-presets` |             | `boolean`             | `true`      |
+| `oasEndpoint`      | `oas-endpoint`       |             | `string \| undefined` | `undefined` |
 
 
 ## Dependencies

diff --git a/vscode-data.json b/vscode-data.json
@@ -181,6 +181,14 @@
         {
           "name": "editor-id",
           "description": ""
+        },
+        {
+          "name": "load-local-presets",
+          "description": ""
+        },
+        {
+          "name": "oas-endpoint",
+          "description": ""
         }
       ]
     }