@metrichor/epi2me-web - npm Package Compare versions

Comparing version 4.0.4208387 to 4.0.4222914

cjs/graphql-types.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generated/graphql.type"), exports);

cjs/index-web.js

@@ -31,1 +31,2 @@ "use strict";
 exports.Helpers = __importStar(require("./helpers"));
+exports.graphQLSchema = __importStar(require("./graphql-types"));

esm/index-web.js

@@ -5,1 +5,2 @@ import { GraphQL } from './graphql';
 export { GraphQL, EPI2ME_RPC };
+export * as graphQLSchema from './graphql-types';

package.json

@@ -12,3 +12,3 @@ {
   "private": false,
-  "version": "4.0.4208387",
+  "version": "4.0.4222914",
   "main": "cjs/index-web.js",
@@ -15,0 +15,0 @@ "module": "esm/index-web.js",

README.md

@@ -171,1 +171,8 @@ <a href="http://metrichor.com"><img src="https://epi2me.nanoporetech.com/gfx/logo_print.png" height="74" align="right"></a>
 If any other methods are called, then they populate the error argument to the callback with a message.
+
+
+### Development
+
+#### Updating the GraphQL type definitions
+
+The majority of the the GraphQL types in the project are generated directly from the schema file. To update them replace the `./schema.graphql` file with the revised schema, then run `npm run build:graphql` to update the generated types. 

types/graphql-types.d.ts

@@ -1,327 +0,3 @@
-export declare type Maybe<T> = T | null;
-/** All built-in and custom scalars, mapped to their actual values */
-export declare type Scalars = {
-    ID: string;
-    String: string;
-    Boolean: boolean;
-    Int: number;
-    Float: number;
-    DateTime: unknown;
-    GenericScalar: unknown;
-};
-export declare type AccountObjectType = {
-    __typename?: 'AccountObjectType';
-    created: Scalars['DateTime'];
-    lastModified: Scalars['DateTime'];
-    idAccount: Scalars['ID'];
-    sfId?: Maybe<Scalars['String']>;
-    number: Scalars['String'];
-    name?: Maybe<Scalars['String']>;
-    isDeleted: Scalars['Int'];
-    isShared: Scalars['Int'];
-    useraccountSet: Array<UserAccountObjectType>;
-};
-export declare type AttributeParams = {
-    name: Scalars['String'];
-    value: Scalars['String'];
-};
-export declare type AttributeType = {
-    __typename?: 'AttributeType';
-    idAttribute: Scalars['ID'];
-    name: Scalars['String'];
-    description: Scalars['String'];
-    type: Scalars['String'];
-    format: Scalars['String'];
-    errorMessage?: Maybe<Scalars['String']>;
-    idUserOwner: Scalars['Float'];
-    created?: Maybe<Scalars['DateTime']>;
-    lastModified?: Maybe<Scalars['DateTime']>;
-    isMutable: Scalars['Int'];
-    attributevalueSet: Array<AttributeValueType>;
-};
-export declare type AttributeValueType = {
-    __typename?: 'AttributeValueType';
-    idAttributeValue: Scalars['ID'];
-    attribute: AttributeType;
-    value?: Maybe<Scalars['String']>;
-    idUserOwner: Scalars['Float'];
-    created?: Maybe<Scalars['DateTime']>;
-    lastModified?: Maybe<Scalars['DateTime']>;
-    workflowSet: Array<WorkflowType>;
-    workflowinstanceSet: Array<WorkflowInstanceType>;
-};
-export declare type DatasetStatusType = {
-    __typename?: 'DatasetStatusType';
-    idDatasetStatus: Scalars['ID'];
-    value: Scalars['String'];
-    label?: Maybe<Scalars['String']>;
-    created?: Maybe<Scalars['DateTime']>;
-    lastModified: Scalars['DateTime'];
-    datasetSet: Array<DatasetType>;
-};
-export declare type DatasetType = {
-    __typename?: 'DatasetType';
-    idDataset: Scalars['ID'];
-    uuid: Scalars['String'];
-    idAccount: Scalars['Float'];
-    prefix: Scalars['String'];
-    name?: Maybe<Scalars['String']>;
-    idUser: Scalars['Float'];
-    size: Scalars['Float'];
-    summary?: Maybe<Scalars['String']>;
-    source?: Maybe<Scalars['String']>;
-    componentId: Scalars['String'];
-    isConsentedHuman?: Maybe<Scalars['Int']>;
-    registrationParams?: Maybe<Scalars['GenericScalar']>;
-    datasetStatus: DatasetStatusType;
-    created: Scalars['DateTime'];
-    lastModified: Scalars['DateTime'];
-    workflowinstanceSet: Array<WorkflowInstanceType>;
-};
-export declare type InstanceTokenMutation = {
-    __typename?: 'InstanceTokenMutation';
-    idWorkflowInstance?: Maybe<Scalars['ID']>;
-    accessKeyId?: Maybe<Scalars['String']>;
-    secretAccessKey?: Maybe<Scalars['String']>;
-    sessionToken?: Maybe<Scalars['String']>;
-    expiration?: Maybe<Scalars['DateTime']>;
-    region?: Maybe<Scalars['String']>;
-};
-export declare type Mutation = {
-    __typename?: 'Mutation';
-    startWorkflowInstance?: Maybe<WorkflowInstanceMutation>;
-    stopWorkflowInstance?: Maybe<StopWorkflowInstanceMutation>;
-    getInstanceToken?: Maybe<InstanceTokenMutation>;
-    registerToken?: Maybe<RegisterTokenMutation>;
-    updateUser?: Maybe<UpdateUserMutation>;
-};
-export declare type MutationStartWorkflowInstanceArgs = {
-    computeAccountId: Scalars['ID'];
-    idDataset?: Maybe<Scalars['ID']>;
-    idWorkflow: Scalars['ID'];
-    instanceAttributes?: Maybe<Array<Maybe<Scalars['GenericScalar']>>>;
-    isConsentedHuman?: Maybe<Scalars['Boolean']>;
-    region?: Maybe<Scalars['String']>;
-    storageAccountId?: Maybe<Scalars['ID']>;
-    storeResults?: Maybe<Scalars['Boolean']>;
-    userDefined?: Maybe<Scalars['GenericScalar']>;
-};
-export declare type MutationStopWorkflowInstanceArgs = {
-    idWorkflowInstance: Scalars['ID'];
-};
-export declare type MutationGetInstanceTokenArgs = {
-    idWorkflowInstance: Scalars['ID'];
-    readOnly?: Maybe<Scalars['Boolean']>;
-};
-export declare type MutationRegisterTokenArgs = {
-    code: Scalars['String'];
-    description?: Maybe<Scalars['String']>;
-};
-export declare type MutationUpdateUserArgs = {
-    idRegionPreferred: Scalars['ID'];
-};
-export declare type PaginatedDatasetType = PaginatedInterface & {
-    __typename?: 'PaginatedDatasetType';
-    page?: Maybe<Scalars['Int']>;
-    pages?: Maybe<Scalars['Int']>;
-    hasNext?: Maybe<Scalars['Boolean']>;
-    hasPrevious?: Maybe<Scalars['Boolean']>;
-    totalCount?: Maybe<Scalars['Int']>;
-    results?: Maybe<Array<Maybe<DatasetType>>>;
-};
-export declare type PaginatedInterface = {
-    page?: Maybe<Scalars['Int']>;
-    pages?: Maybe<Scalars['Int']>;
-    hasNext?: Maybe<Scalars['Boolean']>;
-    hasPrevious?: Maybe<Scalars['Boolean']>;
-    totalCount?: Maybe<Scalars['Int']>;
-};
-export declare type PaginatedWorkflowInstanceType = PaginatedInterface & {
-    __typename?: 'PaginatedWorkflowInstanceType';
-    page?: Maybe<Scalars['Int']>;
-    pages?: Maybe<Scalars['Int']>;
-    hasNext?: Maybe<Scalars['Boolean']>;
-    hasPrevious?: Maybe<Scalars['Boolean']>;
-    totalCount?: Maybe<Scalars['Int']>;
-    results?: Maybe<Array<Maybe<WorkflowInstanceType>>>;
-};
-export declare type PaginatedWorkflowType = PaginatedInterface & {
-    __typename?: 'PaginatedWorkflowType';
-    page?: Maybe<Scalars['Int']>;
-    pages?: Maybe<Scalars['Int']>;
-    hasNext?: Maybe<Scalars['Boolean']>;
-    hasPrevious?: Maybe<Scalars['Boolean']>;
-    totalCount?: Maybe<Scalars['Int']>;
-    results?: Maybe<Array<Maybe<WorkflowType>>>;
-};
-export declare type Query = {
-    __typename?: 'Query';
-    allWorkflowInstances?: Maybe<PaginatedWorkflowInstanceType>;
-    workflowInstance?: Maybe<WorkflowInstanceType>;
-    allWorkflows?: Maybe<PaginatedWorkflowType>;
-    allDatasets?: Maybe<PaginatedDatasetType>;
-    workflow?: Maybe<WorkflowType>;
-    status?: Maybe<StatusType>;
-    regions?: Maybe<Array<Maybe<RegionType>>>;
-    allUsers?: Maybe<Array<Maybe<UserObjectType>>>;
-    allUserAccounts?: Maybe<Array<Maybe<UserAccountObjectType>>>;
-    me?: Maybe<UserObjectType>;
-};
-export declare type QueryAllWorkflowInstancesArgs = {
-    idUser?: Maybe<Scalars['ID']>;
-    shared?: Maybe<Scalars['Boolean']>;
-    page?: Maybe<Scalars['Int']>;
-    pageSize?: Maybe<Scalars['Int']>;
-    orderBy?: Maybe<Scalars['String']>;
-};
-export declare type QueryWorkflowInstanceArgs = {
-    idWorkflowInstance: Scalars['ID'];
-};
-export declare type QueryAllWorkflowsArgs = {
-    isActive?: Maybe<Scalars['Int']>;
-    attrsFilter?: Maybe<AttributeParams>;
-    region?: Maybe<Scalars['String']>;
-    page?: Maybe<Scalars['Int']>;
-    pageSize?: Maybe<Scalars['Int']>;
-    orderBy?: Maybe<Scalars['String']>;
-};
-export declare type QueryAllDatasetsArgs = {
-    page?: Maybe<Scalars['Int']>;
-    pageSize?: Maybe<Scalars['Int']>;
-    orderBy?: Maybe<Scalars['String']>;
-};
-export declare type QueryWorkflowArgs = {
-    idWorkflow: Scalars['ID'];
-};
-export declare type RegionType = {
-    __typename?: 'RegionType';
-    idRegion: Scalars['ID'];
-    provider?: Maybe<Scalars['String']>;
-    name: Scalars['String'];
-    description: Scalars['String'];
-    workflowimageSet: Array<WorkflowImageType>;
-};
-export declare type RegisterTokenMutation = {
-    __typename?: 'RegisterTokenMutation';
-    apikey?: Maybe<Scalars['String']>;
-    apisecret?: Maybe<Scalars['String']>;
-    description?: Maybe<Scalars['String']>;
-};
-export declare type ReportType = {
-    __typename?: 'ReportType';
-    idReport: Scalars['ID'];
-    name: Scalars['String'];
-    idOwner: Scalars['Float'];
-    url: Scalars['String'];
-    revision: Scalars['String'];
-    created?: Maybe<Scalars['DateTime']>;
-    lastModified: Scalars['DateTime'];
-    workflowSet: Array<WorkflowType>;
-};
-export declare type StatusType = {
-    __typename?: 'StatusType';
-    minimumAgent?: Maybe<Scalars['String']>;
-    dbVersion?: Maybe<Scalars['String']>;
-    portalVersion?: Maybe<Scalars['String']>;
-    remoteAddr?: Maybe<Scalars['String']>;
-    serverTime?: Maybe<Scalars['DateTime']>;
-};
-export declare type StopWorkflowInstanceMutation = {
-    __typename?: 'StopWorkflowInstanceMutation';
-    success?: Maybe<Scalars['Boolean']>;
-    message?: Maybe<Scalars['String']>;
-};
-export declare type UpdateUserMutation = {
-    __typename?: 'UpdateUserMutation';
-    idRegionPreferred?: Maybe<Scalars['ID']>;
-};
-export declare type UserAccountObjectType = {
-    __typename?: 'UserAccountObjectType';
-    created: Scalars['DateTime'];
-    lastModified: Scalars['DateTime'];
-    idUserAccount: Scalars['ID'];
-    user: UserObjectType;
-    account: AccountObjectType;
-    role: Scalars['String'];
-    agreementNumber?: Maybe<Scalars['String']>;
-    isActive: Scalars['Int'];
-};
-export declare type UserObjectType = {
-    __typename?: 'UserObjectType';
-    created: Scalars['DateTime'];
-    lastModified: Scalars['DateTime'];
-    idUser: Scalars['ID'];
-    username: Scalars['String'];
-    realname: Scalars['String'];
-    isActive: Scalars['Int'];
-    idRegionPreferred: Scalars['Int'];
-    useraccountSet: Array<UserAccountObjectType>;
-};
-export declare type WorkflowImageType = {
-    __typename?: 'WorkflowImageType';
-    idWorkflowImage: Scalars['ID'];
-    region: RegionType;
-    workflow: WorkflowType;
-    inputqueue?: Maybe<Scalars['String']>;
-    userdataCommand?: Maybe<Scalars['String']>;
-    userdateScript?: Maybe<Scalars['String']>;
-    dockerImage?: Maybe<Scalars['String']>;
-    workflowinstanceSet: Array<WorkflowInstanceType>;
-};
-export declare type WorkflowInstanceMutation = {
-    __typename?: 'WorkflowInstanceMutation';
-    bucket?: Maybe<Scalars['String']>;
-    idUser?: Maybe<Scalars['Int']>;
-    instance?: Maybe<WorkflowInstanceType>;
-    remoteAddr?: Maybe<Scalars['String']>;
-};
-export declare type WorkflowInstanceType = {
-    __typename?: 'WorkflowInstanceType';
-    idWorkflowInstance: Scalars['ID'];
-    idUser: Scalars['Float'];
-    startDate: Scalars['DateTime'];
-    stopDate?: Maybe<Scalars['DateTime']>;
-    workflowImage: WorkflowImageType;
-    outputqueue?: Maybe<Scalars['String']>;
-    chain?: Maybe<Scalars['GenericScalar']>;
-    isConsentedHuman?: Maybe<Scalars['Int']>;
-    lastModified?: Maybe<Scalars['DateTime']>;
-    attributes: Array<AttributeValueType>;
-    dataset: Array<DatasetType>;
-    telemetry?: Maybe<Scalars['GenericScalar']>;
-    mappedTelemetry?: Maybe<Scalars['GenericScalar']>;
-    keyId?: Maybe<Scalars['String']>;
-    state?: Maybe<Scalars['String']>;
-};
-export declare type WorkflowRelationshipType = {
-    __typename?: 'WorkflowRelationshipType';
-    idWorkflowTree: Scalars['ID'];
-    workflow: WorkflowType;
-    workflowParent: WorkflowType;
-};
-export declare type WorkflowType = {
-    __typename?: 'WorkflowType';
-    idWorkflow: Scalars['ID'];
-    idUserOwner: Scalars['Float'];
-    description: Scalars['String'];
-    rev: Scalars['String'];
-    isActive: Scalars['Int'];
-    chain?: Maybe<Scalars['GenericScalar']>;
-    config?: Maybe<Scalars['GenericScalar']>;
-    dataFields?: Maybe<Scalars['String']>;
-    created?: Maybe<Scalars['DateTime']>;
-    lastModified?: Maybe<Scalars['DateTime']>;
-    name?: Maybe<Scalars['String']>;
-    summary?: Maybe<Scalars['String']>;
-    doc?: Maybe<Scalars['String']>;
-    aggregationConfig?: Maybe<Scalars['GenericScalar']>;
-    reports: Array<ReportType>;
-    attributes: Array<AttributeValueType>;
-    workflowImages: Array<WorkflowImageType>;
-    workflowRelationshipParent: Array<WorkflowRelationshipType>;
-    workflowRelationshipChildren: Array<WorkflowRelationshipType>;
-    isNested?: Maybe<Scalars['Boolean']>;
-    params?: Maybe<Scalars['GenericScalar']>;
-    mappedAttributes?: Maybe<Scalars['GenericScalar']>;
-};
+import type { PaginatedWorkflowType, PaginatedWorkflowInstanceType, WorkflowInstanceType, WorkflowInstanceMutation, StopWorkflowInstanceMutation, InstanceTokenMutation, UserObjectType, UpdateUserMutation, RegisterTokenMutation, RegionType, WorkflowType, StatusType } from './generated/graphql.type';
+export * from './generated/graphql.type';
 export declare type ResponseAllWorkflows = {
@@ -328,0 +4,0 @@ allWorkflows: PaginatedWorkflowType;

types/index-web.d.ts

@@ -5,1 +5,2 @@ import { GraphQL } from './graphql';
 export { GraphQL, EPI2ME_RPC };
+export * as graphQLSchema from './graphql-types';

No alert changes

Improved metrics

Total package byte prevSize

2395190

increased by0.08%

Number of package files

160

increased by3.23%

Lines of code

27326

increased by0.11%

Number of lines in readme file

178

increased by4.09%

No dependency changes