@data-fair/lib-common-types 1.0.0 → 1.1.0

package/session/.type/index.js

@@ -6,8 +6,7 @@ import { assertValid as assertValidGeneric } from '@data-fair/lib-node/validatio
 
 export const schemaExports = [
   "types",
-  "validate",
-  "schema"
+  "validate"
 ]
 
 export { validate } from './validate.js'
@@ -18,168 +17,3 @@ export const returnValid = (data, options) => {
   assertValid(data, options)
   return data
 }
-
-export const schema = {
-  "$id": "https://github.com/data-fair/lib/session-state",
-  "x-exports": [
-    "types",
-    "validate",
-    "schema"
-  ],
-  "type": "object",
-  "title": "session state",
-  "additionalProperties": false,
-  "properties": {
-    "user": {
-      "$ref": "#/$defs/user"
-    },
-    "organization": {
-      "$ref": "#/$defs/organizationMembership"
-    },
-    "account": {
-      "$ref": "#/$defs/account"
-    },
-    "accountRole": {
-      "type": "string"
-    },
-    "lang": {
-      "type": "string"
-    },
-    "dark": {
-      "type": "boolean"
-    }
-  },
-  "$defs": {
-    "organizationMembership": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "id",
-        "name",
-        "role"
-      ],
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        },
-        "role": {
-          "type": "string"
-        },
-        "department": {
-          "type": "string"
-        },
-        "departmentName": {
-          "type": "string"
-        },
-        "dflt": {
-          "type": "boolean"
-        }
-      }
-    },
-    "userRef": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "id",
-        "name"
-      ],
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        }
-      }
-    },
-    "user": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "email",
-        "id",
-        "name",
-        "organizations"
-      ],
-      "properties": {
-        "email": {
-          "type": "string",
-          "format": "email"
-        },
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        },
-        "organizations": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/organizationMembership"
-          }
-        },
-        "isAdmin": {
-          "type": "integer",
-          "enum": [
-            0,
-            1
-          ]
-        },
-        "adminMode": {
-          "type": "integer",
-          "enum": [
-            0,
-            1
-          ]
-        },
-        "asAdmin": {
-          "$ref": "#/$defs/userRef"
-        },
-        "pd": {
-          "type": "string",
-          "format": "date"
-        },
-        "ipa": {
-          "type": "integer",
-          "enum": [
-            0,
-            1
-          ]
-        }
-      }
-    },
-    "account": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "type",
-        "id",
-        "name"
-      ],
-      "properties": {
-        "type": {
-          "type": "string",
-          "enum": [
-            "user",
-            "organization"
-          ]
-        },
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        },
-        "department": {
-          "type": "string"
-        },
-        "departmentName": {
-          "type": "string"
-        }
-      }
-    }
-  }
-}

package/session/.type/validate.js

@@ -5,7 +5,7 @@ import { fullFormats } from "ajv-formats/dist/formats.js";
 "use strict";
 export const validate = validate14;
 export default validate14;
-const schema16 = {"$id":"https://github.com/data-fair/lib/session-state","x-exports":["types","validate","schema"],"type":"object","title":"session state","additionalProperties":false,"properties":{"user":{"$ref":"#/$defs/user"},"organization":{"$ref":"#/$defs/organizationMembership"},"account":{"$ref":"#/$defs/account"},"accountRole":{"type":"string"},"lang":{"type":"string"},"dark":{"type":"boolean"}},"$defs":{"organizationMembership":{"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"boolean"}}},"userRef":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"user":{"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[0,1]},"adminMode":{"type":"integer","enum":[0,1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","enum":[0,1]}}},"account":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}}}};
+const schema16 = {"$id":"https://github.com/data-fair/lib/session-state","x-exports":["types","validate"],"type":"object","title":"session state","additionalProperties":false,"properties":{"user":{"$ref":"#/$defs/user"},"organization":{"$ref":"#/$defs/organizationMembership"},"account":{"$ref":"#/$defs/account"},"accountRole":{"type":"string"},"lang":{"type":"string"},"dark":{"type":"boolean"}},"$defs":{"organizationMembership":{"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"boolean"}}},"userRef":{"type":"object","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"user":{"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[0,1]},"adminMode":{"type":"integer","enum":[0,1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","enum":[0,1]}}},"account":{"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}}}};
 const schema18 = {"type":"object","additionalProperties":false,"required":["id","name","role"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"},"dflt":{"type":"boolean"}}};
 const schema21 = {"type":"object","additionalProperties":false,"required":["type","id","name"],"properties":{"type":{"type":"string","enum":["user","organization"]},"id":{"type":"string"},"name":{"type":"string"},"department":{"type":"string"},"departmentName":{"type":"string"}}};
 const schema17 = {"type":"object","additionalProperties":false,"required":["email","id","name","organizations"],"properties":{"email":{"type":"string","format":"email"},"id":{"type":"string"},"name":{"type":"string"},"organizations":{"type":"array","items":{"$ref":"#/$defs/organizationMembership"}},"isAdmin":{"type":"integer","enum":[0,1]},"adminMode":{"type":"integer","enum":[0,1]},"asAdmin":{"$ref":"#/$defs/userRef"},"pd":{"type":"string","format":"date"},"ipa":{"type":"integer","enum":[0,1]}}};

package/session/schema.d.ts

@@ -0,0 +1,133 @@
+declare const _default: {
+    $id: string;
+    'x-exports': string[];
+    type: string;
+    title: string;
+    additionalProperties: boolean;
+    properties: {
+        user: {
+            $ref: string;
+        };
+        organization: {
+            $ref: string;
+        };
+        account: {
+            $ref: string;
+        };
+        accountRole: {
+            type: string;
+        };
+        lang: {
+            type: string;
+        };
+        dark: {
+            type: string;
+        };
+    };
+    $defs: {
+        organizationMembership: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                id: {
+                    type: string;
+                };
+                name: {
+                    type: string;
+                };
+                role: {
+                    type: string;
+                };
+                department: {
+                    type: string;
+                };
+                departmentName: {
+                    type: string;
+                };
+                dflt: {
+                    type: string;
+                };
+            };
+        };
+        userRef: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                id: {
+                    type: string;
+                };
+                name: {
+                    type: string;
+                };
+            };
+        };
+        user: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                email: {
+                    type: string;
+                    format: string;
+                };
+                id: {
+                    type: string;
+                };
+                name: {
+                    type: string;
+                };
+                organizations: {
+                    type: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                isAdmin: {
+                    type: string;
+                    enum: number[];
+                };
+                adminMode: {
+                    type: string;
+                    enum: number[];
+                };
+                asAdmin: {
+                    $ref: string;
+                };
+                pd: {
+                    type: string;
+                    format: string;
+                };
+                ipa: {
+                    type: string;
+                    enum: number[];
+                };
+            };
+        };
+        account: {
+            type: string;
+            additionalProperties: boolean;
+            required: string[];
+            properties: {
+                type: {
+                    type: string;
+                    enum: string[];
+                };
+                id: {
+                    type: string;
+                };
+                name: {
+                    type: string;
+                };
+                department: {
+                    type: string;
+                };
+                departmentName: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/session/schema.js

@@ -0,0 +1,157 @@
+export default {
+  $id: 'https://github.com/data-fair/lib/session-state',
+  'x-exports': ['types', 'validate'],
+  type: 'object',
+  title: 'session state',
+  additionalProperties: false,
+  properties: {
+    user: {
+      $ref: '#/$defs/user'
+    },
+    organization: {
+      $ref: '#/$defs/organizationMembership'
+    },
+    account: {
+      $ref: '#/$defs/account'
+    },
+    accountRole: {
+      type: 'string'
+    },
+    lang: {
+      type: 'string'
+    },
+    dark: {
+      type: 'boolean'
+    }
+  },
+  $defs: {
+    organizationMembership: {
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'id',
+        'name',
+        'role'
+      ],
+      properties: {
+        id: {
+          type: 'string'
+        },
+        name: {
+          type: 'string'
+        },
+        role: {
+          type: 'string'
+        },
+        department: {
+          type: 'string'
+        },
+        departmentName: {
+          type: 'string'
+        },
+        dflt: {
+          type: 'boolean'
+        }
+      }
+    },
+    userRef: {
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'id',
+        'name'
+      ],
+      properties: {
+        id: {
+          type: 'string'
+        },
+        name: {
+          type: 'string'
+        }
+      }
+    },
+    user: {
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'email',
+        'id',
+        'name',
+        'organizations'
+      ],
+      properties: {
+        email: {
+          type: 'string',
+          format: 'email'
+        },
+        id: {
+          type: 'string'
+        },
+        name: {
+          type: 'string'
+        },
+        organizations: {
+          type: 'array',
+          items: {
+            $ref: '#/$defs/organizationMembership'
+          }
+        },
+        isAdmin: {
+          type: 'integer',
+          enum: [
+            0,
+            1
+          ]
+        },
+        adminMode: {
+          type: 'integer',
+          enum: [
+            0,
+            1
+          ]
+        },
+        asAdmin: {
+          $ref: '#/$defs/userRef'
+        },
+        pd: {
+          type: 'string',
+          format: 'date'
+        },
+        ipa: {
+          type: 'integer',
+          enum: [
+            0,
+            1
+          ]
+        }
+      }
+    },
+    account: {
+      type: 'object',
+      additionalProperties: false,
+      required: [
+        'type',
+        'id',
+        'name'
+      ],
+      properties: {
+        type: {
+          type: 'string',
+          enum: ['user', 'organization']
+        },
+        id: {
+          type: 'string'
+        },
+        name: {
+          type: 'string'
+        },
+        department: {
+          type: 'string'
+        },
+        departmentName: {
+          type: 'string'
+        }
+      }
+    }
+  }
+}

package/account/schema.json

@@ -1,45 +0,0 @@
-{
-  "$id": "https://github.com/data-fair/lib/account",
-  "x-exports": ["types", "validate", "schema"],
-  "type":"object",
-  "title": "account",
-  "required": ["type", "id", "name"],
-  "properties":{
-    "type":{
-      "type":"string",
-      "enum": ["user", "organization"]
-    },
-    "id":{
-      "type":"string"
-    },
-    "name":{
-      "type":"string"
-    },
-    "department":{
-      "type":"string"
-    },
-    "departmentName":{
-      "type":"string"
-    }
-  },
-  "$defs": {
-    "accountKeys": {
-      "type": "object",
-      "title": "account keys",
-      "required": ["type", "id"],
-      "additionalProperties": false,
-      "properties": {
-        "type":{
-          "type":"string",
-          "enum": ["user", "organization"]
-        },
-        "id": {
-          "type": "string"
-        },
-        "department": {
-          "type": "string"
-        }
-      }
-    }
-  }
-}

package/application/schema.json

@@ -1,141 +0,0 @@
-{
-  "$id": "https://github.com/data-fair/lib/application",
-  "title": "Application",
-  "x-exports": [
-    "types",
-    "schema"
-  ],
-  "type": "object",
-  "required": [
-    "id",
-    "title",
-    "exposedUrl",
-    "href",
-    "wsUrl",
-    "owner",
-    "configuration"
-  ],
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "Globally unique identifier of the application"
-    },
-    "title": {
-      "type": "string",
-      "description": "Short title of the application"
-    },
-    "exposedUrl": {
-      "type": "string",
-      "description": "The URL where this application is exposed"
-    },
-    "href": {
-      "type": "string",
-      "description": "The URL where this resource can be fetched"
-    },
-    "wsUrl": {
-      "type": "string",
-      "description": "The URL where this application can be accessed through a websocket"
-    },
-    "owner": {
-      "$ref": "https://github.com/data-fair/lib/account#/$defs/accountKeys"
-    },
-    "configuration": {
-      "type": "object",
-      "description": "A free format configuration object used by applications. A minimal common structure is used to ensure proper linking between applications and datasets and remote services",
-      "additionalProperties": true,
-      "properties": {
-        "datasets": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/dataset"
-          }
-        }
-      }
-    }
-  },
-  "$defs": {
-    "dataset": {
-      "type": [
-        "object",
-        "null"
-      ],
-      "required": [
-        "href",
-        "id",
-        "title",
-        "finalizedAt"
-      ],
-      "properties": {
-        "href": {
-          "type": "string"
-        },
-        "id": {
-          "type": "string"
-        },
-        "title": {
-          "type": "string"
-        },
-        "key": {
-          "type": "string",
-          "description": "Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context."
-        },
-        "schema": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/field"
-          }
-        },
-        "finalizedAt": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
-    "field": {
-      "type": "object",
-      "required": [
-        "key",
-        "type"
-      ],
-      "properties": {
-        "key": {
-          "type": "string"
-        },
-        "type": {
-          "type": "string"
-        },
-        "format": {
-          "type": "string"
-        },
-        "title": {
-          "type": "string"
-        },
-        "x-originalName": {
-          "type": "string"
-        },
-        "x-group": { "type": "string" },
-        "x-refersTo": {
-          "deprecated": true,
-          "type": ["string", "null"]
-        },
-        "x-concept": {
-          "type": "object",
-          "properties": {
-            "id": { "type": "string" },
-            "title": { "type": "string" },
-            "primary": { "type": "boolean" }
-          }
-        },
-        "x-labels": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "string"
-          }
-        },
-        "x-labelsRestricted": {
-          "type": "boolean"
-        }
-      }
-    }
-  }
-}