@nuffieldtechnologies/rugged-schema-types 2.0.0 → 2.1.0

package/index.ts

@@ -1,306 +1,36 @@
-const _TimeStamps = `
-    type TimeStamps {
-        started: String,
-        updated: String, 
-        discarded: String,
-        submitted: String, 
-        processed: String,
-        upgraded: String
-    }
-`;
-const _TimeStampsInput = `
-    input TimeStampsInput {
-        started: String,
-        updated: String, 
-        discarded: String,
-        submitted: String, 
-        processed: String,
-        upgraded: String
-    }
-`;
-
-const _Event = `
-    type Event {
-        appVersion: String, 
-        at: Float, 
-        atForHumans: String, 
-        device: String, 
-        deviceModel: String,
-        osVersion: String, 
-        user: String,
-        userEmail: String
-    }
-`
-
-const _EventInput = `
-    input EventInput {
-        appVersion: String, 
-        at: Float, 
-        atForHumans: String, 
-        device: String, 
-        deviceModel: String,
-        osVersion: String, 
-        user: String,
-        userEmail: String
-    }
-`;
-
-const _Events = `
-type Events {
-    started: Event,
-    updated: Event, 
-    submitted: Event,
-    discarded: Event,
-}
-`;
-
-const _EventsInput = `
-input EventsInput {
-    started: EventInput,
-    updated: EventInput, 
-    submitted: EventInput,
-    discarded: EventInput,
-}
-`;
-
-const _TemplateInfo = `
-    type TemplateInfo {
-        name: String,
-        shortName: String,
-        type: String, 
-        id: String
-        version: String
-    }
-`;
-
-const _TemplateInfoInput = `
-    input TemplateInfoInput {
-        name: String,
-        shortName: String,
-        type: String, 
-        id: String
-        version: String
-    }
-`;
-
-const _TaskIdentifiers = `
-    type TaskIdentifiers {
-        primary: String
-        secondary: String
-    }
-`;
-
-const _TaskIdentifiersInput = `
-    input TaskIdentifiersInput {
-        primary: String
-        secondary: String
-    }
-`;
-
-const _Task = `
-    type Task {
-        id: ID,
-        name: String
-        definition: String
-        user: ID
-        userEmail: String
-        form: ID
-        organisation: ID
-        timestamps: TimeStamps
-        events: Events
-        template: TemplateInfo
-        identifiers: TaskIdentifiers
-        status: String
-        fails: [String]
-        reportUrl: String
-        data: String
-        refNo: String
-    }
-`;
-
-const _AllEventFields = `{appVersion, at, atForHumans, device, deviceModel, osVersion, user, userEmail}`;
-
-const _AllTaskFields = `{id, name, definition, user, userEmail, form, id, organisation, timestamps {started, updated, submitted, processed, upgraded} events {started ${_AllEventFields}, updated ${_AllEventFields}, submitted ${_AllEventFields}, discarded ${_AllEventFields}} , template { name, shortName, type, id, version}, identifiers { primary, secondary}, status, fails, reportUrl, data, refNo}`;
-
-const _TaskInput = `
-    input TaskInput {
-        # The name of the task. TODO does this actually exist?
-        name: String,
-
-        # A short description of the task
-        description: String
-
-        # The definition of the task
-        definition: String!,
-
-        # The id of the user who submitted the task TODO is this right? 
-        user: ID
-        
-        # The email of the user who submitted the task
-        userEmail: String, 
-
-        form: ID
-        id: ID
-        organisation: ID
-        status: String
-        fails: [String]
-        reportUrl: String
-        timestamps: TimeStampsInput
-        events: EventsInput
-        template: TemplateInfoInput
-        identifiers: TaskIdentifiersInput
-        data: String
-
-        #A unique identifier for the task that is intended to be human-readable.
-        refNo: String
-    }
-`;
-
-const _TaskFilter = `
-    input TaskFilter {
-        users: [ID]
-        userEmails: [String]
-        forms: [ID]
-        after: String
-        before: String
-    },
-`;
-
-const _Roles = `
-    type Roles {
-        user: Boolean
-        admin: Boolean
-        api: Boolean
-        uber: Boolean 
-        super: Boolean
-        legacyPush: Boolean
-    }
-`;
-
-const _RolesInput = `
-    input RolesInput {
-        user: Boolean
-        admin: Boolean
-        api: Boolean
-    }
-`;
-
-const _User = `
-    type User {
-        id: ID
-        organisation: ID
-        firebaseId: ID
-        name: String
-        email: String
-        roles: Roles
-        permissions: String
-    }
-`;
-
-const _UserInput = `
-    input UserInput {
-        id: ID
-        organisation: ID
-        firebaseId: ID
-        name: String
-        email: String
-        roles: RolesInput
-    }
-`;
-
-const _AllRolesFields = `{user, admin, api, uber, super, legacyPush}`;
-const _AllUserFields = `{id, organisation, name, email, roles ${_AllRolesFields}, permissions}`;
-
-const _FormInput = `
-
-    input ParamInput {
-        name: String
-        value: String
-    }
-
-    input FormInput {
-        id: ID
-        name: String
-        key: String
-        definition: String
-        version: String
-        status: String
-        updated: String
-        params: [ParamInput]
-        resources: String
-        body: String
-    }
-`;
-
-const _FormFilter = `
-    input FormFilter {
-        status: String
-    }
-`;
-
-const _Form = `
-
-    type Param {
-        name: String
-        value: String
-    }
-
-    type Form {
-        id: ID
-        name: String
-        key: String
-        definition: String
-        version: String
-        status: String
-        updated: String
-        params: [Param]
-        resources: String
-        body: String
-    }
-`;
-
-const _AllFormFields = `{id, name, key, definition, status,  updated, params {name, value}, resources, body}`;
-
-const _OrganisationInput = `
-    input OrganisationInput {
-        id: ID
-        name: String
-        logoUrl: String
-    }
-`;
-
-const _Organisation = `
-    type Organisation {
-        id: ID
-        name: String
-        logoUrl: String
-    }
-`;
-
-const _AllOrganisationFields = `{id, name, logoUrl}`;
-
-export const Task = _TimeStamps  + _Event + _Events + _TemplateInfo + _Task + _TaskIdentifiers;
-export const TaskInput = _TimeStampsInput + _EventInput + _EventsInput + _TemplateInfoInput + _TaskInput + _TaskIdentifiersInput;
-export const TaskFilter = _TaskFilter;
-export const Tasks = Task + TaskInput + TaskFilter;
-export const AllTaskFields = _AllTaskFields;
-
-export const User = _Roles + _User;
-export const UserInput = _RolesInput + _UserInput;
+import * as TimeStamps from './schemas/timestamps'
+import * as Events from './schemas/events'
+import * as TemplateInfo from './schemas/template-info'
+import * as UserSchemas from './schemas/user'
+import * as Roles from './schemas/roles'
+import * as FormShemas from './schemas/form'
+import * as OrganisationSchemas from './schemas/organisation'
+import * as TaskIdentifiers from './schemas/task-identifiers'
+import * as TaskOldSchemas from './schemas/task-old'
+import * as TaskSchemas from './schemas/task'
+
+export const Task = TimeStamps._TimeStamps  + Events._Event + Events._Events + TemplateInfo._TemplateInfo + TaskSchemas._Task + TaskIdentifiers._TaskIdentifiers;
+export const TaskInput = TimeStamps._TimeStampsInput + Events._EventInput + Events._EventsInput + TemplateInfo._TemplateInfoInput + TaskSchemas._TaskInput + TaskIdentifiers._TaskIdentifiersInput;
+export const TaskFilter = TaskSchemas._TaskFilter;
+export const Tasks = Task + TaskInput + TaskFilter + TaskOldSchemas._TaskOld + TaskSchemas._TaskInfo + TaskSchemas._TaskInfoInput;
+export const AllTaskFields = TaskSchemas._AllTaskFields;
+
+export const User = Roles._Roles + UserSchemas._User;
+export const UserInput = Roles._RolesInput + UserSchemas._UserInput;
 export const Users = User + UserInput;
-export const AllUserFields = _AllUserFields;
-export const AllRolesFields = _AllRolesFields;
+export const AllUserFields = UserSchemas._AllUserFields;
+export const AllRolesFields = Roles._AllRolesFields;
 
-export const Form = _Form;
-export const FormInput = _FormInput;
-export const FormFilter = _FormFilter;
+export const Form = FormShemas._Form;
+export const FormInput = FormShemas._FormInput;
+export const FormFilter = FormShemas._FormFilter;
 export const Forms = Form + FormInput + FormFilter;
-export const AllFormFields = _AllFormFields;
+export const AllFormFields = FormShemas._AllFormFields;
 
-export const Organisation = _Organisation;
-export const OrganisationInput = _OrganisationInput;
+export const Organisation = OrganisationSchemas._Organisation;
+export const OrganisationInput = OrganisationSchemas._OrganisationInput;
 export const Organisations = Organisation + OrganisationInput;
-export const AllOrganisationFields = _AllOrganisationFields;
+export const AllOrganisationFields = OrganisationSchemas._AllOrganisationFields;
 
 export const All = Tasks + Users + Forms + Organisations;
 export default All;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuffieldtechnologies/rugged-schema-types",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Graphql schema for rugged data",
   "main": "dist/index.js",
   "keywords": [
@@ -22,7 +22,7 @@
   "license": "UNLICENSED",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint --fix './*.ts'",
+    "lint": "eslint --fix './**/*.ts'",
     "prebuild": "npm run lint",
     "build": "tsc",
     "push": "npm run build && npm publish"

package/schemas/events.ts

@@ -0,0 +1,49 @@
+export const _Event = `
+    type Event {
+        appVersion: String, 
+        at: Float, 
+        atForHumans: String, 
+        device: String, 
+        deviceModel: String,
+        osVersion: String, 
+        user: String,
+        userEmail: String
+    }
+`
+
+export const _EventInput = `
+    input EventInput {
+        appVersion: String, 
+        at: Float, 
+        atForHumans: String, 
+        device: String, 
+        deviceModel: String,
+        osVersion: String, 
+        user: String,
+        userEmail: String
+    }
+`;
+
+export const _Events = `
+    type Events {
+        started: Event,
+        updated: Event, 
+        upgraded: Event,
+        processed: Event,
+        submitted: Event,
+        discarded: Event,
+    }
+`;
+
+export const _EventsInput = `
+    input EventsInput {
+        started: EventInput,
+        updated: EventInput, 
+        upgraded: EventInput,
+        processed: EventInput,
+        submitted: EventInput,
+        discarded: EventInput,
+    }
+`;
+
+export const _AllEventFields = `{appVersion, at, atForHumans, device, deviceModel, osVersion, user, userEmail}`;

package/schemas/form.ts

@@ -0,0 +1,49 @@
+export const _FormInput = `
+
+    input ParamInput {
+        name: String
+        value: String
+    }
+
+    input FormInput {
+        id: ID
+        name: String
+        key: String
+        definition: String
+        version: String
+        status: String
+        updated: String
+        params: [ParamInput]
+        resources: String
+        body: String
+    }
+`;
+
+export const _Form = `
+
+    type Param {
+        name: String
+        value: String
+    }
+
+    type Form {
+        id: ID
+        name: String
+        key: String
+        definition: String
+        version: String
+        status: String
+        updated: String
+        params: [Param]
+        resources: String
+        body: String
+    }
+`;
+
+export const _FormFilter = `
+    input FormFilter {
+        status: String
+    }
+`;
+
+export const _AllFormFields = `{id, name, key, definition, status,  updated, params {name, value}, resources, body}`;

package/schemas/organisation.ts

@@ -0,0 +1,17 @@
+export const _OrganisationInput = `
+    input OrganisationInput {
+        id: ID
+        name: String
+        logoUrl: String
+    }
+`;
+
+export const _Organisation = `
+    type Organisation {
+        id: ID
+        name: String
+        logoUrl: String
+    }
+`;
+
+export const _AllOrganisationFields = `{id, name, logoUrl}`;

package/schemas/roles.ts

@@ -0,0 +1,20 @@
+export const _Roles = `
+    type Roles {
+        user: Boolean
+        admin: Boolean
+        api: Boolean
+        uber: Boolean 
+        super: Boolean
+        legacyPush: Boolean
+    }
+`;
+
+export const _RolesInput = `
+    input RolesInput {
+        user: Boolean
+        admin: Boolean
+        api: Boolean
+    }
+`;
+
+export const _AllRolesFields = `{user, admin, api, uber, super, legacyPush}`;

package/schemas/task-identifiers.ts

@@ -0,0 +1,13 @@
+export const _TaskIdentifiers = `
+    type TaskIdentifiers {
+        primary: String
+        secondary: String
+    }
+`;
+
+export const _TaskIdentifiersInput = `
+    input TaskIdentifiersInput {
+        primary: String
+        secondary: String
+    }
+`;

package/schemas/task-old.ts

@@ -0,0 +1,20 @@
+export const _TaskOld = `
+    type Task {
+        id: ID,
+        name: String
+        definition: String
+        user: ID
+        userEmail: String
+        form: ID
+        organisation: ID
+        timestamps: TimeStamps
+        events: Events
+        template: TemplateInfo
+        identifiers: TaskIdentifiers
+        status: String
+        fails: [String]
+        reportUrl: String
+        data: String
+        refNo: String
+    }
+`;

package/schemas/task.ts

@@ -0,0 +1,61 @@
+import * as Events from './events'
+
+export const _Task = `
+    type Task {
+        collections: String
+        fields: String
+        info: TaskInfo
+    }
+`;
+
+export const _TaskInfo = `
+    type TaskInfo {
+        status: string
+        rootEntityId: string
+        id: string
+        refNo: number
+        name: string
+        events: Events
+        identifiers: TaskIdentifiers
+        template: TemplateInfo
+        userIds: String
+        users: String
+        timestamps: TimeStamps
+    }
+`;
+
+export const _TaskInput = `
+    input TaskInput {
+        collections: String
+        fields: String
+        info: TaskInfoInput
+    }
+`;
+
+export const _TaskInfoInput = `
+    input TaskInfoInput {
+        status: string
+        rootEntityId: string
+        id: string
+        refNo: number
+        name: string
+        events: EventInput
+        identifiers: TaskIdentifiersInput
+        template: TemplateInfoInput
+        userIds: String
+        users: String
+        timestamps: TimeStampsInput
+    }
+`;
+
+export const _TaskFilter = `
+    input TaskFilter {
+        users: [ID]
+        userEmails: [String]
+        forms: [ID]
+        after: String
+        before: String
+    },
+`;
+
+export const _AllTaskFields = `{collections, fields, info {status, id, rootEntityId, refNo, userIds, users, timestamps {started, updated, submitted, processed, upgraded, discarded}, events {started ${Events._AllEventFields}, updated ${Events._AllEventFields}, submitted ${Events._AllEventFields}, discarded ${Events._AllEventFields}, processed ${Events._AllEventFields}, upgraded ${Events._AllEventFields}}, template { name, shortName, type, id, version}, identifiers { primary, secondary}}}`;

package/schemas/template-info.ts

@@ -0,0 +1,19 @@
+export const _TemplateInfo = `
+    type TemplateInfo {
+        name: String,
+        shortName: String,
+        type: String, 
+        id: String
+        version: String
+    }
+`;
+
+export const _TemplateInfoInput = `
+    input TemplateInfoInput {
+        name: String,
+        shortName: String,
+        type: String, 
+        id: String
+        version: String
+    }
+`;

package/schemas/timestamps.ts

@@ -0,0 +1,20 @@
+export const _TimeStamps = `
+    type TimeStamps {
+        started: String,
+        updated: String, 
+        discarded: String,
+        submitted: String, 
+        processed: String,
+        upgraded: String
+    }
+`;
+export const _TimeStampsInput = `
+    input TimeStampsInput {
+        started: String,
+        updated: String, 
+        discarded: String,
+        submitted: String, 
+        processed: String,
+        upgraded: String
+    }
+`;

package/schemas/user.ts

@@ -0,0 +1,26 @@
+import * as Roles from './roles'
+
+export const _User = `
+    type User {
+        id: ID
+        organisation: ID
+        firebaseId: ID
+        name: String
+        email: String
+        roles: Roles
+        permissions: String
+    }
+`;
+
+export const _UserInput = `
+    input UserInput {
+        id: ID
+        organisation: ID
+        firebaseId: ID
+        name: String
+        email: String
+        roles: RolesInput
+    }
+`;
+
+export const _AllUserFields = `{id, organisation, name, email, roles ${Roles._AllRolesFields}, permissions}`;