Skip to content

Commit

Permalink
1.20.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jbernal0019 committed Apr 11, 2024
1 parent dae06cc commit a861252
Show file tree
Hide file tree
Showing 12 changed files with 140 additions and 374 deletions.
2 changes: 1 addition & 1 deletion js/chrisAPI/dist/node/main.js

Large diffs are not rendered by default.

171 changes: 60 additions & 111 deletions js/chrisAPI/dist/types/client.d.ts

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions js/chrisAPI/dist/types/feed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,22 @@ export class FeedList extends ListResource {
limit?: number;
offset?: number;
}, timeout?: number): Promise<ComputeResourceList>;
/**
* Fetch a list of plugin metas from the REST API.
*
* @param {Object} [searchParams=null] - search parameters object which is
* resource-specific, the ``PluginMetaList.getSearchParameters`` method can be
* used to get a list of possible search parameters
* @param {number} [searchParams.limit] - page limit
* @param {number} [searchParams.offset] - page offset
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<PluginMetaList>} - JS Promise, resolves to a ``PluginMetaList`` object
*/
getPluginMetas(searchParams?: {
limit?: number;
offset?: number;
}, timeout?: number): Promise<PluginMetaList>;
/**
* Fetch a list of plugins from the REST API.
*
Expand Down Expand Up @@ -225,22 +241,6 @@ export class FeedList extends ListResource {
limit?: number;
offset?: number;
}, timeout?: number): Promise<PipelineList>;
/**
* Fetch a list of pipeline instances from the REST API.
*
* @param {Object} [searchParams=null] - search parameters object which is
* resource-specific, the ``AllPipelineInstanceList.getSearchParameters`` method
* can be used to get a list of possible search parameters
* @param {number} [searchParams.limit] - page limit
* @param {number} [searchParams.offset] - page offset
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<AllPipelineInstanceList>} - JS Promise, resolves to a ``AllPipelineInstanceList`` object
*/
getPipelineInstances(searchParams?: {
limit?: number;
offset?: number;
}, timeout?: number): Promise<AllPipelineInstanceList>;
/**
* Fetch a list of tags from the REST API.
*
Expand Down Expand Up @@ -306,21 +306,21 @@ export class FeedList extends ListResource {
offset?: number;
}, timeout?: number): Promise<PACSFileList>;
/**
* Fetch a list of files for an unregistered service from the REST API.
* Fetch a list of PACS series from the REST API.
*
* @param {Object} [searchParams=null] - search parameters object which is
* resource-specific, the ``ServiceFileList.getSearchParameters`` method can
* resource-specific, the ``PACSSeriesList.getSearchParameters`` method can
* be used to get a list of possible search parameters
* @param {number} [searchParams.limit] - page limit
* @param {number} [searchParams.offset] - page offset
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<ServiceFileList>} - JS Promise, resolves to a ``ServiceFileList`` object
* @return {Promise<PACSSeriesList>} - JS Promise, resolves to a ``PACSSeriesList`` object
*/
getServiceFiles(searchParams?: {
getPACSSeriesList(searchParams?: {
limit?: number;
offset?: number;
}, timeout?: number): Promise<ServiceFileList>;
}, timeout?: number): Promise<PACSSeriesList>;
/**
* Fetch a list of file browser folders (the returned list only has at most one element) from the REST API.
*
Expand Down Expand Up @@ -361,14 +361,14 @@ import { FeedPluginInstanceList } from "./plugininstance";
import { ListResource } from "./resource";
import User from "./user";
import { ComputeResourceList } from "./computeresource";
import { PluginMetaList } from "./pluginmeta";
import { PluginList } from "./plugin";
import { PluginAdminList } from "./admin";
import { AllPluginInstanceList } from "./plugininstance";
import { PipelineList } from "./pipeline";
import { AllPipelineInstanceList } from "./pipelineinstance";
import { TagList } from "./tag";
import { PipelineSourceFileList } from "./pipeline";
import { UserFileList } from "./userfile";
import { PACSFileList } from "./pacsfile";
import { ServiceFileList } from "./servicefile";
import { PACSSeriesList } from "./pacsfile";
import { FileBrowserFolderList } from "./filebrowser";
13 changes: 13 additions & 0 deletions js/chrisAPI/dist/types/filebrowser.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,19 @@ export class FileBrowserFolder extends ItemResource {
* File browser folder list resource object representing a list of folders.
*/
export class FileBrowserFolderList extends ListResource {
/**
* Make a POST request to this file browser folder list resource to create a new file browser
* folder item resource through the REST API.
*
* @param {Object} data - request JSON data object
* @param {string} [data.path] - folder path
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<this>} - JS Promise, resolves to ``this`` object
*/
post(data: {
path?: string;
}, timeout?: number): Promise<FileBrowserFolderList>;
}
/**
* File browser folder child list resource object representing a list of all
Expand Down
10 changes: 3 additions & 7 deletions js/chrisAPI/dist/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ import { PluginInstanceSplit } from "./plugininstance";
import { PluginInstanceParameterList } from "./plugininstance";
import { PluginInstanceParameter } from "./plugininstance";
import { FeedPluginInstanceList } from "./plugininstance";
import { PipelineInstancePluginInstanceList } from "./plugininstance";
import { WorkflowPluginInstanceList } from "./plugininstance";
import { PipelineList } from "./pipeline";
import { PipelinePluginList } from "./pipeline";
Expand All @@ -44,9 +43,6 @@ import { PluginPiping } from "./pipeline";
import { PipingDefaultParameter } from "./pipeline";
import { PipelineSourceFileList } from "./pipeline";
import { PipelineSourceFile } from "./pipeline";
import { AllPipelineInstanceList } from "./pipelineinstance";
import { PipelineInstanceList } from "./pipelineinstance";
import { PipelineInstance } from "./pipelineinstance";
import { AllWorkflowList } from "./workflow";
import { WorkflowList } from "./workflow";
import { Workflow } from "./workflow";
Expand All @@ -64,9 +60,9 @@ import { Comment } from "./comment";
import { UserFileList } from "./userfile";
import { UserFile } from "./userfile";
import { PACSFileList } from "./pacsfile";
import { PACSSeriesList } from "./pacsfile";
import { PACSFile } from "./pacsfile";
import { ServiceFileList } from "./servicefile";
import { ServiceFile } from "./servicefile";
import { PACSSeries } from "./pacsfile";
import { FileBrowserFolderList } from "./filebrowser";
import { FileBrowserFolderChildList } from "./filebrowser";
import { FileBrowserFolder } from "./filebrowser";
Expand All @@ -76,4 +72,4 @@ import { FileBrowserFolderLinkFileList } from "./filebrowser";
import { FileBrowserFolderLinkFile } from "./filebrowser";
import { DownloadTokenList } from "./downloadtoken";
import { DownloadToken } from "./downloadtoken";
export { Request, Collection, RequestException, ListResource, ItemResource, Resource, ChrisInstance, FeedList, PublicFeedList, Feed, ComputeResourceAdminList, ComputeResourceAdmin, PluginAdminList, PluginAdmin, PluginList, PluginMetaPluginList, Plugin, PluginMetaList, PluginMeta, PluginParameterList, PluginParameter, PluginComputeResourceList, ComputeResourceList, ComputeResource, PluginInstanceDescendantList, PluginInstanceList, PluginInstance, AllPluginInstanceList, PluginInstanceSplitList, PluginInstanceSplit, PluginInstanceParameterList, PluginInstanceParameter, FeedPluginInstanceList, PipelineInstancePluginInstanceList, WorkflowPluginInstanceList, PipelineList, PipelinePluginList, PipelinePluginPipingList, Pipeline, PipelinePipingDefaultParameterList, PluginPiping, PipingDefaultParameter, PipelineSourceFileList, PipelineSourceFile, AllPipelineInstanceList, PipelineInstanceList, PipelineInstance, AllWorkflowList, WorkflowList, Workflow, TagList, Tag, TagTaggingList, FeedTaggingList, Tagging, TagFeedList, FeedTagList, Note, User, CommentList, Comment, UserFileList, UserFile, PACSFileList, PACSFile, ServiceFileList, ServiceFile, FileBrowserFolderList, FileBrowserFolderChildList, FileBrowserFolder, FileBrowserFolderFileList, FileBrowserFolderFile, FileBrowserFolderLinkFileList, FileBrowserFolderLinkFile, DownloadTokenList, DownloadToken };
export { Request, Collection, RequestException, ListResource, ItemResource, Resource, ChrisInstance, FeedList, PublicFeedList, Feed, ComputeResourceAdminList, ComputeResourceAdmin, PluginAdminList, PluginAdmin, PluginList, PluginMetaPluginList, Plugin, PluginMetaList, PluginMeta, PluginParameterList, PluginParameter, PluginComputeResourceList, ComputeResourceList, ComputeResource, PluginInstanceDescendantList, PluginInstanceList, PluginInstance, AllPluginInstanceList, PluginInstanceSplitList, PluginInstanceSplit, PluginInstanceParameterList, PluginInstanceParameter, FeedPluginInstanceList, WorkflowPluginInstanceList, PipelineList, PipelinePluginList, PipelinePluginPipingList, Pipeline, PipelinePipingDefaultParameterList, PluginPiping, PipingDefaultParameter, PipelineSourceFileList, PipelineSourceFile, AllWorkflowList, WorkflowList, Workflow, TagList, Tag, TagTaggingList, FeedTaggingList, Tagging, TagFeedList, FeedTagList, Note, User, CommentList, Comment, UserFileList, UserFile, PACSFileList, PACSSeriesList, PACSFile, PACSSeries, FileBrowserFolderList, FileBrowserFolderChildList, FileBrowserFolder, FileBrowserFolderFileList, FileBrowserFolderFile, FileBrowserFolderLinkFileList, FileBrowserFolderLinkFile, DownloadTokenList, DownloadToken };
38 changes: 38 additions & 0 deletions js/chrisAPI/dist/types/pacsfile.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
/**
* PACS series item resource object representing a PACS series.
*/
export class PACSSeries extends ItemResource {
/**
* Constructor
*
* @param {string} url - url of the resource
* @param {Object} auth - authentication object
* @param {string} auth.token - authentication token
*/
constructor(url: string, auth: {
token: string;
});
/**
* Fetch the folder associated with this PACS series from the REST API.
*
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<FileBrowserFolder>} - JS Promise, resolves to a ``FileBrowserFolder`` object
*/
getFolder(timeout?: number): Promise<FileBrowserFolder>;
}
/**
* PACS series list resource object representing a list of PACS series.
*/
export class PACSSeriesList extends ListResource {
/**
* Constructor
*
* @param {string} url - url of the resource
* @param {Object} auth - authentication object
* @param {string} auth.token - authentication token
*/
constructor(url: string, auth: {
token: string;
});
}
/**
* PACS file item resource object representing a PACS file.
*/
Expand Down
31 changes: 0 additions & 31 deletions js/chrisAPI/dist/types/pipeline.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,6 @@ export class Pipeline extends ItemResource {
limit?: number;
offset?: number;
}, timeout?: number): Promise<PipelinePipingDefaultParameterList>;
/**
* Fetch a list of pipeline instances associated to this pipeline from the REST API.
*
* @param {Object} [params=null] - page parameters object
* @param {number} [params.limit] - page limit
* @param {number} [params.offset] - page offset
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<PipelineInstanceList>} - JS Promise, resolves to a ``PipelineInstanceList`` object
*/
getPipelineInstances(params?: {
limit?: number;
offset?: number;
}, timeout?: number): Promise<PipelineInstanceList>;
/**
* Fetch a list of workflows associated to this pipeline from the REST API.
*
Expand All @@ -73,14 +59,6 @@ export class Pipeline extends ItemResource {
limit?: number;
offset?: number;
}, timeout?: number): Promise<WorkflowList>;
/**
* Fetch the source fle associated to this pipeline from the REST API.
*
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<PipelineSourceFile>} - JS Promise, resolves to a ``PipelineSourceFile`` object
*/
getPipelineSourceFile(timeout?: number): Promise<PipelineSourceFile>;
/**
* Make a PUT request to modify this pipeline resource through the REST API.
*
Expand Down Expand Up @@ -241,14 +219,6 @@ export class PipelineSourceFile extends ItemResource {
* @return {Promise<Blob>} - JS Promise, resolves to a ``Blob`` object
*/
getFileBlob(timeout?: number): Promise<Blob>;
/**
* Fetch the pipeline associated to this source file from the REST API.
*
* @param {number} [timeout=30000] - request timeout
*
* @return {Promise<Pipeline>} - JS Promise, resolves to a ``Pipeline`` object
*/
getPipeline(timeout?: number): Promise<Pipeline>;
/**
* Fetch the parent folder of this file from the REST API.
*
Expand Down Expand Up @@ -281,7 +251,6 @@ export class PipelineSourceFileList extends ListResource {
}, timeout?: number): Promise<PipelineSourceFileList>;
}
import { ItemResource } from "./resource";
import { PipelineInstanceList } from "./pipelineinstance";
import { WorkflowList } from "./workflow";
import { ListResource } from "./resource";
import { PluginList } from "./plugin";
Expand Down
125 changes: 0 additions & 125 deletions js/chrisAPI/dist/types/pipelineinstance.d.ts

This file was deleted.

Loading

0 comments on commit a861252

Please sign in to comment.