vue-girder-slicer-cli-ui 0.0.8

package/README.md

@@ -0,0 +1,102 @@
+# Girder Slicer UI
+
+This is a vue based component library to interface with the girder slicer CLI plugin. 
+https://github.com/girder/slicer_cli_web
+
+This Vue component library can be used with the above plugin to list and set values for slicer CLI plugins.
+
+# GirderSlicerTasksIntegrated.vue
+
+This is a single component that provies a listing of the tasks as well as an interface to set the paramemter values.
+
+## Customization
+
+### apiURL
+The URL of the base girder instance that contains the slicer cli plugin.  This defaults to the current host `/api/v1`
+
+### filter
+A filter function that can be used to remove tasks from the listing.  This will be run on every task that is returned from the `/slicer_cli_web/cli` endpoint.  It takes a function of the type `(item: SlicerTask) => boolean` where returning true will display the task and returning false will filter out the task.
+
+```
+export interface SlicerTask {
+    _id: string;
+    description: string;
+    image: string;
+    name: string;
+    type: string;
+}
+```
+
+### defaults
+
+A function that iterates through every task parameter and enables setting default values.
+`(item: XMLParameters) => undefined | null | XMLParameters`
+```
+export interface XMLParameters {
+  type: ParamSlicerType;
+  slicerType: ParamGUIType;
+  title: string;
+  description: string;
+  channel?: 'input' | 'output';
+  id: string;
+  value?: XMLBaseValue;
+  values?: XMLBaseValue[];
+  constraints?: {min?: XMLBaseValue; max?: XMLBaseValue; step?: XMLBaseValue};
+  defaultValue?: XMLBaseValue;
+  // Extra
+  fileValue?: {
+    girderId: string; // item/folder Id for the selected item
+    name: string; //File Name for display purposes
+    parentId: string; // Parent folder to open when using DataBrowser
+    regExp?: boolean | undefined; // When selecting multiple the regExp pattern
+    fileId?: string | undefined; // fileId used
+  }; // Added to handle files
+  required?: boolean;
+  extensions?: string | undefined;
+  reference?: string | undefined;
+  defaultNameMatch?: string | undefined;
+  defaultPathMatch?: string | undefined;
+  defaultRelativePath?: string | undefined;
+  multiple?: boolean;
+  datalist?: boolean;
+  shapes?: string | undefined;
+  error?: string | undefined; // Used to display errors
+}
+```
+You can take the XMLParameter information and set a default `fileValue` or default  `value | values` to indicate what it should be.
+I.E:
+```
+(item: XMLParamemters) => {
+    if (item.channel == 'input' and item.type === 'file') {
+        const updatedItem = {...item}
+        item.fileValue = {
+          fileId: '6433f9123b271b58c749ddbc',
+          girderId: '6433f9123b271b58c749ddbb',
+          name: 'SampleVideo.mp4',
+          parentId: '6433f9113b271b58c749ddb6',
+          regExp: false,
+        }
+    }
+}
+```
+This is used to set default values.
+
+## Color Customization
+
+There are some global css variables that are used to set the colors used in the system:
+```
+  :root {
+    --gsu-color-primary: #90CAF9; /* Primary color */
+    --gsu-color-secondary: #9FA8DA; /* Secondary color */
+    --gsu-color-link: #2c7596; /* Link color */
+    --gsu-color-text: #FFFFFF; /* Text color */
+    --gsu-color-muted-text: #B0BEC5; /* Muted text color */
+    --gsu-color-background: rgb(39, 39, 39);/* Background color */
+    --gsu-color-border: rgba(255,255,255,0.3);
+    --gsu-background-muted: #212121; /* Muted background color */
+    --gsu-color-highlight: #717171bb; /* Highlighted color */
+    --gsu-color-selected: #A5D6A7; /* Selected color */
+  }
+```
+This default view mimics a vuetify dark theme but not completely.
+These variables can be modified to change the visual styling of the system.

package/dist/api/girderRest.d.ts

@@ -0,0 +1,36 @@
+import { Axios, AxiosInstance } from 'axios';
+export interface GirderRestClientParams {
+    apiRoot: string;
+    token?: string;
+    axios?: AxiosInstance;
+    authenticateWithCredentials?: boolean;
+    userGirderAuthorizationHeader?: boolean;
+    setLocalCookie?: boolean;
+}
+export declare const OauthTokenPrefix = "#girderToken=";
+export declare const OauthTokenSuffix = "__";
+/**
+ * This is a subclass of axios that is meant to add Girder-specific helper functionality.
+ */
+export default class RestClient extends Axios {
+    apiRoot: string;
+    token: string | null;
+    axios: AxiosInstance;
+    authenticateWithCredentials: boolean;
+    useGirderAuthorizationHeader: boolean;
+    setLocalCookie: boolean;
+    user: null | any;
+    $on: Function | undefined;
+    constructor({ apiRoot, token, axios, authenticateWithCredentials, useGirderAuthorizationHeader, setLocalCookie, }?: {
+        apiRoot?: string | undefined;
+        token?: string | undefined;
+        axios?: AxiosInstance | undefined;
+        authenticateWithCredentials?: boolean | undefined;
+        useGirderAuthorizationHeader?: boolean | undefined;
+        setLocalCookie?: boolean | undefined;
+    });
+    login(username: string, password: string, otp?: null): Promise<import("axios").AxiosResponse<any, any>>;
+    logout(): Promise<void>;
+    fetchUser(): Promise<any>;
+    register(login: string, email: string, firstName: string, lastName: string, password: string, admin?: boolean): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/dist/api/girderSlicerApi.d.ts

@@ -0,0 +1,32 @@
+import { XMLBaseValue, XMLSpecification } from "../parser/parserTypes";
+import RestClient from "./girderRest";
+export interface SlicerImage {
+    _id: string;
+    description: string;
+    image: string;
+    name: string;
+    type: string;
+}
+export interface JobResponse {
+    _id: string;
+    _original_name: string;
+    celeryTaskId: string;
+    title: string;
+    type: string;
+}
+export interface SlicerTask {
+    _id: string;
+    description: string;
+    image: string;
+    name: string;
+    type: string;
+}
+declare const useGirderSlicerApi: (girderRest: RestClient) => {
+    getSlicerList: () => Promise<import("axios").AxiosResponse<SlicerImage[], any>>;
+    getSlicerXML: (id: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    validateParams: (xml: XMLSpecification) => boolean;
+    convertToParams: (xml: XMLSpecification) => Record<string, XMLBaseValue>;
+    runTask: (xml: XMLSpecification, taskid: string) => Promise<false | JobResponse>;
+    processInput: (xml: XMLSpecification, name: string) => Promise<void>;
+};
+export { useGirderSlicerApi };

package/dist/components/FileBrowser/DataBrowser.tw.vue.d.ts

@@ -0,0 +1,177 @@
+import { PropType, Ref } from 'vue';
+import { GirderModel, GirderModelType } from '../../girderTypes';
+declare const _default: import("vue").DefineComponent<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    multi: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    output: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    validation: {
+        type: PropType<(id: GirderModel) => ({
+            valid: boolean;
+            msg?: string;
+        })>;
+        default: () => {
+            valid: boolean;
+        };
+    };
+    parentId: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    girderId: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    name: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+}, {
+    home: Ref<string | null>;
+    collections: Ref<GirderModel[] | null>;
+    user: Ref<GirderModel | null>;
+    rootFolders: Ref<GirderModel[] | null>;
+    folderCount: Ref<number>;
+    folderShow: Ref<boolean>;
+    folderOffset: Ref<number>;
+    rootItems: Ref<GirderModel[] | null>;
+    itemCount: Ref<number>;
+    itemShow: Ref<boolean>;
+    itemOffset: Ref<number>;
+    iconMap: Ref<{
+        user: string;
+        collection: string;
+        folder: string;
+        item: string;
+        file: string;
+    }>;
+    breadCrumb: Ref<{
+        type: GirderModelType;
+        path: {
+            name: string;
+            id: string;
+        }[];
+    }>;
+    selected: Ref<{
+        name: string;
+        girderId: string;
+        parentId?: string | undefined;
+        fileId?: string | undefined;
+    } | null>;
+    selectedItems: Ref<Record<string, boolean>>;
+    selectedModel: Ref<GirderModel | null>;
+    errorMsg: Ref<string>;
+    users: Ref<GirderModel[] | null>;
+    currentParentType: Ref<string>;
+    mdiAccount: string;
+    mdiArrowUpRightBold: string;
+    mdiChevronDoubleLeft: string;
+    mdiChevronDoubleRight: string;
+    mdiChevronDown: string;
+    mdiChevronLeft: string;
+    mdiChevronRight: string;
+    mdiChevronUp: string;
+    mdiClose: string;
+    mdiEarth: string;
+    mdiFile: string;
+    mdiFolder: string;
+    mdiLock: string;
+    mdiSitemap: string;
+    updateOffset: (type: 'folder' | 'item', value: number) => void;
+    setRegularExpression: (data: string) => void;
+    setSelectedName: (data: string) => Promise<void>;
+    updateMainView: (parentId: string, parentType: string, name?: string, resetShow?: boolean) => Promise<void>;
+    upLevel: () => void;
+    countFormatter: (count: number | null) => string | number;
+    setRoot: ({ val, type, name }: {
+        val: string;
+        type: GirderModelType;
+        name: string;
+    }) => Promise<void>;
+    convertInputString: (e: Event) => string;
+    convertInputNumber: (e: Event) => number;
+    selecting: (item: GirderModel, type: 'folder' | 'file') => Promise<void>;
+    submit: () => Promise<void>;
+    sizeFormatter: (size: number, { base, unit }?: {
+        base?: number | undefined;
+        unit?: string | undefined;
+    }) => string;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    multi: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    limit: {
+        type: NumberConstructor;
+        default: number;
+    };
+    output: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    validation: {
+        type: PropType<(id: GirderModel) => ({
+            valid: boolean;
+            msg?: string;
+        })>;
+        default: () => {
+            valid: boolean;
+        };
+    };
+    parentId: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    girderId: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    name: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+}>>, {
+    multi: boolean;
+    output: boolean;
+    name: string;
+    type: string;
+    parentId: string;
+    apiUrl: string;
+    limit: number;
+    validation: (id: GirderModel) => ({
+        valid: boolean;
+        msg?: string;
+    });
+    girderId: string;
+}>;
+export default _default;

package/dist/components/FileBrowser/Modal.tw.vue.d.ts

@@ -0,0 +1,27 @@
+declare const _default: import("vue").DefineComponent<{
+    isVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabledConfirm: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    cancel: () => void;
+    confirm: () => void;
+    mdiClose: string;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    isVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabledConfirm: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    isVisible: boolean;
+    disabledConfirm: boolean;
+}>;
+export default _default;

package/dist/components/FileBrowser/RootSelection.tw.vue.d.ts

@@ -0,0 +1,41 @@
+import { PropType } from 'vue';
+import { GirderModel } from '../../girderTypes';
+declare const _default: import("vue").DefineComponent<{
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    home: {
+        type: StringConstructor;
+        required: true;
+    };
+    users: {
+        type: PropType<GirderModel[]>;
+        required: true;
+    };
+    collections: {
+        type: PropType<GirderModel[]>;
+        required: true;
+    };
+}, {
+    filteredUsers: import("vue").ComputedRef<GirderModel[]>;
+    update: (e: Event) => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    home: {
+        type: StringConstructor;
+        required: true;
+    };
+    users: {
+        type: PropType<GirderModel[]>;
+        required: true;
+    };
+    collections: {
+        type: PropType<GirderModel[]>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

package/dist/components/FileBrowser/utils.d.ts

@@ -0,0 +1,9 @@
+declare const sizeFormatter: (size: number, { base, unit }?: {
+    base?: number | undefined;
+    unit?: string | undefined;
+}) => string;
+declare const countFormatter: (count: number | null) => string | number;
+declare const convertInputNumber: (e: Event) => number;
+declare const convertInputString: (e: Event) => string;
+declare function isValidRegex(pattern: string): boolean;
+export { sizeFormatter, isValidRegex, countFormatter, convertInputNumber, convertInputString, };

package/dist/components/GirderControlsPanel.tw.vue.d.ts

@@ -0,0 +1,29 @@
+import { PropType } from 'vue';
+import type { XMLPanel, XMLParameters } from '../parser/parserTypes';
+declare const _default: import("vue").DefineComponent<{
+    panel: {
+        type: PropType<XMLPanel>;
+        required: true;
+    };
+    collapseOverride: {
+        type: BooleanConstructor;
+        required: false;
+    };
+}, {
+    collapsed: import("vue").Ref<boolean>;
+    updateParams: (e: XMLParameters[]) => void;
+    mdiChevronDown: string;
+    mdiChevronUp: string;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    panel: {
+        type: PropType<XMLPanel>;
+        required: true;
+    };
+    collapseOverride: {
+        type: BooleanConstructor;
+        required: false;
+    };
+}>>, {
+    collapseOverride: boolean;
+}>;
+export default _default;

package/dist/components/GirderSlicerParameter.tw.vue.d.ts

@@ -0,0 +1,50 @@
+import { PropType } from 'vue';
+import type { XMLParameters } from '../parser/parserTypes';
+declare const _default: import("vue").DefineComponent<{
+    parameters: {
+        type: PropType<XMLParameters[]>;
+        required: true;
+    };
+}, {
+    baseParmaeters: string[];
+    paramCopy: import("vue").Ref<{
+        type: import("../parser/parserTypes").ParamSlicerType;
+        slicerType: import("../parser/parserTypes").ParamGUIType;
+        title: string;
+        description: string;
+        channel?: "input" | "output" | undefined;
+        id: string;
+        value?: import("../parser/parserTypes").XMLBaseValue | undefined;
+        values?: import("../parser/parserTypes").XMLBaseValue[] | undefined;
+        constraints?: {
+            min?: import("../parser/parserTypes").XMLBaseValue | undefined;
+            max?: import("../parser/parserTypes").XMLBaseValue | undefined;
+            step?: import("../parser/parserTypes").XMLBaseValue | undefined;
+        } | undefined;
+        defaultValue?: import("../parser/parserTypes").XMLBaseValue | undefined;
+        fileValue?: {
+            girderId: string;
+            name: string;
+            parentId: string;
+            regExp?: boolean | undefined;
+            fileId?: string | undefined;
+        } | undefined;
+        required?: boolean | undefined;
+        extensions?: string | undefined;
+        reference?: string | undefined;
+        defaultNameMatch?: string | undefined;
+        defaultPathMatch?: string | undefined;
+        defaultRelativePath?: string | undefined;
+        multiple?: boolean | undefined;
+        datalist?: boolean | undefined;
+        shapes?: string | undefined;
+        error?: string | undefined;
+    }[]>;
+    updateParameter: (data: XMLParameters, index: number) => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    parameters: {
+        type: PropType<XMLParameters[]>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

package/dist/components/GirderSlicerTaskButton.tw.vue.d.ts

@@ -0,0 +1,42 @@
+import { Ref } from "vue";
+type TaskHierarchy = Record<string, {
+    tag: string;
+    tasks: {
+        imageBase: string;
+        imageTag: string;
+        _id: string;
+        name: string;
+        description: string;
+    }[];
+}[]>;
+declare const _default: import("vue").DefineComponent<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {
+    results: Ref<TaskHierarchy>;
+    mdiAlert: string;
+    mdiChevronDown: string;
+    mdiChevronRight: string;
+    loggedIn: import("vue").ComputedRef<string | null>;
+    select: (id: string) => void;
+    clicked: Ref<boolean>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    filter: string;
+    apiUrl: string;
+}>;
+export default _default;

package/dist/components/GirderSlicerTaskCard.tw.vue.d.ts

@@ -0,0 +1,44 @@
+import { PropType, Ref } from 'vue';
+import { JobResponse } from '../api/girderSlicerApi';
+import type { XMLParameters, XMLSpecification } from '../parser/parserTypes';
+declare const _default: import("vue").DefineComponent<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    taskId: {
+        type: PropType<string | null>;
+        default: string;
+    };
+    defaults: {
+        type: PropType<(item: XMLParameters) => undefined | null | XMLParameters>;
+        default: (_item: XMLParameters) => undefined;
+    };
+}, {
+    result: Ref<XMLSpecification | null>;
+    runTask: () => Promise<void>;
+    cancel: () => void;
+    updateParameters: (e: XMLParameters[], index: number) => void;
+    processInput: (name: string) => Promise<void>;
+    jobData: Ref<JobResponse | null>;
+    loggedIn: import("vue").ComputedRef<string | null>;
+    mdiClose: string;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    taskId: {
+        type: PropType<string | null>;
+        default: string;
+    };
+    defaults: {
+        type: PropType<(item: XMLParameters) => undefined | null | XMLParameters>;
+        default: (_item: XMLParameters) => undefined;
+    };
+}>>, {
+    apiUrl: string;
+    taskId: string | null;
+    defaults: (item: XMLParameters) => undefined | null | XMLParameters;
+}>;
+export default _default;

package/dist/components/GirderSlicerTaskMenu.tw.vue.d.ts

@@ -0,0 +1,49 @@
+import { Ref } from "vue";
+import { SlicerImage } from "../api/girderSlicerApi";
+import { PropType } from "vue/types/v3-component-props";
+interface TaskInfo {
+    tag: string;
+    tasks: {
+        imageBase: string;
+        imageTag: string;
+        _id: string;
+        name: string;
+        description: string;
+    }[];
+}
+type TaskHierarchy = Record<string, [
+    TaskInfo
+]>;
+declare const _default: import("vue").DefineComponent<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: PropType<(task: SlicerImage) => boolean>;
+        default: (_task: SlicerImage) => true;
+    };
+}, {
+    results: Ref<TaskHierarchy>;
+    mdiAlert: string;
+    mdiChevronDown: string;
+    mdiChevronRight: string;
+    loggedIn: import("vue").ComputedRef<string | null>;
+    select: (id: string, name: string) => void;
+    clicked: Ref<Record<string, boolean>>;
+    selectItem: (item: string) => void;
+    selected: Ref<string | null>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: PropType<(task: SlicerImage) => boolean>;
+        default: (_task: SlicerImage) => true;
+    };
+}>>, {
+    filter: (task: SlicerImage) => boolean;
+    apiUrl: string;
+}>;
+export default _default;

package/dist/components/GlicerSlicerTaskMenuModal.tw.vue.d.ts

@@ -0,0 +1,34 @@
+import { SlicerImage } from "../api/girderSlicerApi";
+import { PropType } from "vue/types/v3-component-props";
+declare const _default: import("vue").DefineComponent<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: PropType<(task: SlicerImage) => boolean>;
+        default: (_task: SlicerImage) => true;
+    };
+}, {
+    accept: () => void;
+    processSelected: (data: {
+        id: string;
+        name: string;
+    }) => void;
+    selected: import("vue").Ref<string>;
+    selectedId: import("vue").Ref<string>;
+    selectedName: import("vue").Ref<string>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
+    apiUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    filter: {
+        type: PropType<(task: SlicerImage) => boolean>;
+        default: (_task: SlicerImage) => true;
+    };
+}>>, {
+    filter: (task: SlicerImage) => boolean;
+    apiUrl: string;
+}>;
+export default _default;