@sheetxl/scripting-mui 0.8.0-beta.10 → 0.8.0-beta.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sheetxl/scripting-mui",
   "description": "Scripting MUI - MUI script workspace, toolbar and run-script plugin for SheetXL.",
-  "version": "0.8.0-beta.10",
+  "version": "0.8.0-beta.11",
   "license": "SEE LICENSE IN <LICENSE>",
   "type": "module",
   "exports": {
@@ -37,13 +37,13 @@
     "automation"
   ],
   "dependencies": {
-    "@sheetxl/react": "^0.8.0-beta.10",
-    "@sheetxl/scripting-react": "^0.8.0-beta.10",
-    "@sheetxl/sdk": "^0.8.0-beta.10",
-    "@sheetxl/studio-mui": "^0.8.0-beta.10",
-    "@sheetxl/utils": "^0.8.0-beta.10",
-    "@sheetxl/utils-mui": "^0.8.0-beta.10",
-    "@sheetxl/utils-react": "^0.8.0-beta.10",
+    "@sheetxl/react": "^0.8.0-beta.11",
+    "@sheetxl/scripting-react": "^0.8.0-beta.11",
+    "@sheetxl/sdk": "^0.8.0-beta.11",
+    "@sheetxl/studio-mui": "^0.8.0-beta.11",
+    "@sheetxl/utils": "^0.8.0-beta.11",
+    "@sheetxl/utils-mui": "^0.8.0-beta.11",
+    "@sheetxl/utils-react": "^0.8.0-beta.11",
     "clsx": "^2.1.1"
   },
   "peerDependencies": {

package/resources/locales/de/ui.msg.json

@@ -2,6 +2,7 @@
   "insertFunction.fallbackLabel": "Funktion",
   "insertFunction.insertNamed": "{name} einfügen",
   "insertScript.fallbackLabel": "Skript einfügen",
+  "insertScript.loadFailedRetry": "Vorlagen konnten nicht geladen werden. Erneut versuchen",
   "insertScript.loading": "Wird geladen...",
   "runScript.executeNamed": "{name} ausführen",
   "runScript.fallbackLabel": "Makro",

package/resources/locales/en/ui.msg.json

@@ -2,6 +2,7 @@
   "insertFunction.fallbackLabel": "Function",
   "insertFunction.insertNamed": "Insert {name}",
   "insertScript.fallbackLabel": "Insert Script",
+  "insertScript.loadFailedRetry": "Couldn’t load templates. Retry",
   "insertScript.loading": "Loading...",
   "runScript.executeNamed": "Execute {name}",
   "runScript.fallbackLabel": "Macro",

package/types/src/command/InsertScriptCommandButton.d.ts

@@ -2,7 +2,8 @@ import { default as React } from 'react';
 import { CommandPopupButtonProps } from '@sheetxl/utils-mui';
 export interface InsertScriptCommandButtonProps extends CommandPopupButtonProps {
     /**
-     * Path to fetch directory scripts from.
+     * The script templates to read: a URL that serves `templates-scripting/contents.json`.
+     * @defaultValue {@link DEFAULT_SCRIPT_PATH}
      */
     scriptPath?: string;
 }

package/types/src/template/TemplateSelectPanel.d.ts

@@ -1,19 +1,20 @@
 import { default as React } from 'react';
 import { SxProps, Theme } from '@mui/system';
-import { DirectoryFile } from '../utils';
+import { ScriptTemplate } from '../utils';
 export interface TemplateSelectPanelProps extends React.HTMLAttributes<HTMLDivElement> {
     /**
      * MUI SX props {@link https://mui.com/system/getting-started/the-sx-prop/}
      */
     sx?: SxProps<Theme>;
     /**
-     * Path to fetch directory scripts from.
+     * The script templates to read: a URL that serves `templates-scripting/contents.json`.
+     * @defaultValue {@link DEFAULT_SCRIPT_PATH}
      */
     scriptPath?: string;
     /**
      * Called when a script button is clicked
      */
-    onScriptSelect?: (file: DirectoryFile) => void;
+    onScriptSelect?: (file: ScriptTemplate) => void;
     /**
      * Disables every template, for scripts that cannot be changed.
      * @defaultValue false

package/types/src/utils/ScriptTemplates.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Where the script templates are read from when no `scriptPath` is given: the published
+ * `@sheetxl/templates-scripting` for this build's release channel.
+ */
+export declare const DEFAULT_SCRIPT_PATH: string;
+/** How a script template runs, which is also the icon it shows. */
+export type ScriptTemplateIcon = 'formula' | 'macro' | 'autostart';
+/** One script template, with its source loaded. */
+export interface ScriptTemplate {
+    /** The template's path within the catalog (`add.ts`), or `null` for the blank template. */
+    path: string | null;
+    /** The display title. */
+    title: string;
+    summary?: string;
+    icon?: ScriptTemplateIcon;
+    /** The script source. */
+    content: string;
+}
+/**
+ * Load the script templates at `path`, sources included, in the catalog's order.
+ *
+ * @remarks
+ * Loaded once per `path` and shared by every caller. A template whose source does not load is left
+ * out; a catalog that cannot be found rejects.
+ */
+export declare const loadScriptTemplates: (path?: string) => Promise<ScriptTemplate[]>;
+//# sourceMappingURL=ScriptTemplates.d.ts.map

package/types/src/utils/index.d.ts

@@ -1,3 +1,2 @@
-export * from './Utils';
-export * from './FetchDirectory';
+export * from './ScriptTemplates';
 //# sourceMappingURL=index.d.ts.map

package/types/src/utils/FetchDirectory.d.ts

@@ -1,20 +0,0 @@
-export interface DirectoryFile<M = any> {
-    /** `null` for a synthetic entry with no backing file (e.g. the "blank" template). */
-    path: string | null;
-    metadata?: M;
-    content: string;
-}
-export interface DirectoryEntry<M = any> {
-    path: string;
-    metadata?: M;
-}
-/**
- * Fetches and loads 'virtual files' using fetch.
- *
- * @remarks
- * This function only works if there is a directory.json file at the directory path.
- *
- * @returns {Promise<DirectoryFile[]>} A promise that resolves to the content of the directory.
- */
-export declare const fetchDirectory: (directoryPath: string) => Promise<DirectoryFile[]>;
-//# sourceMappingURL=FetchDirectory.d.ts.map

package/types/src/utils/Utils.d.ts

@@ -1,2 +0,0 @@
-export declare const DEFAULT_SCRIPT_PATH: string;
-//# sourceMappingURL=Utils.d.ts.map