@data-fair/lib-common-types 0.1.0

package/account/.type/index.d.ts

@@ -0,0 +1,29 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+export interface Account {
+  type: "user" | "organization";
+  id: string;
+  name: string;
+  department?: string;
+  departmentName?: string;
+  [k: string]: unknown;
+}
+/**
+ * This interface was referenced by `Account`'s JSON-Schema
+ * via the `definition` "accountKeys".
+ */
+export interface AccountKeys {
+  type: "user" | "organization";
+  id: string;
+  department?: string;
+}
+
+
+export const validate: (data: any) => data is Account
+export const assertValid: (data: any, options?: import('@data-fair/lib-node/validation.js').AssertValidOptions) => asserts data is Account
+export const returnValid: (data: any, options?: import('@data-fair/lib-node/validation.js').AssertValidOptions) => Account
+      
+export const schema: any
+        

package/account/.type/index.js

@@ -0,0 +1,83 @@
+/* eslint-disable */
+
+
+import validate from './validate.js'
+import { assertValid as assertValidGeneric } from '@data-fair/lib-node/validation.js'
+
+export const schemaExports = [
+  "types",
+  "validate",
+  "schema"
+]
+
+export { validate } from './validate.js'
+export const assertValid = (data, options) => {
+  assertValidGeneric(validate, data, options)
+}
+export const returnValid = (data, options) => {
+  assertValid(data, options)
+  return data
+}
+
+export const schema = {
+  "$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/account/.type/validate.js

@@ -0,0 +1,128 @@
+/* eslint-disable */
+// @ts-nocheck
+
+"use strict";
+export const validate = validate14;
+export default validate14;
+const schema16 = {"$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"}}}}};
+
+function validate14(data, {instancePath="", parentData, parentDataProperty, rootData=data}={}){
+/*# sourceURL="https://github.com/data-fair/lib/account" */;
+let vErrors = null;
+let errors = 0;
+if(data && typeof data == "object" && !Array.isArray(data)){
+if(data.type === undefined){
+const err0 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "type"},message:"must have required property '"+"type"+"'"};
+if(vErrors === null){
+vErrors = [err0];
+}
+else {
+vErrors.push(err0);
+}
+errors++;
+}
+if(data.id === undefined){
+const err1 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "id"},message:"must have required property '"+"id"+"'"};
+if(vErrors === null){
+vErrors = [err1];
+}
+else {
+vErrors.push(err1);
+}
+errors++;
+}
+if(data.name === undefined){
+const err2 = {instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: "name"},message:"must have required property '"+"name"+"'"};
+if(vErrors === null){
+vErrors = [err2];
+}
+else {
+vErrors.push(err2);
+}
+errors++;
+}
+if(data.type !== undefined){
+let data0 = data.type;
+if(typeof data0 !== "string"){
+const err3 = {instancePath:instancePath+"/type",schemaPath:"#/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err3];
+}
+else {
+vErrors.push(err3);
+}
+errors++;
+}
+if(!((data0 === "user") || (data0 === "organization"))){
+const err4 = {instancePath:instancePath+"/type",schemaPath:"#/properties/type/enum",keyword:"enum",params:{allowedValues: schema16.properties.type.enum},message:"must be equal to one of the allowed values"};
+if(vErrors === null){
+vErrors = [err4];
+}
+else {
+vErrors.push(err4);
+}
+errors++;
+}
+}
+if(data.id !== undefined){
+if(typeof data.id !== "string"){
+const err5 = {instancePath:instancePath+"/id",schemaPath:"#/properties/id/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err5];
+}
+else {
+vErrors.push(err5);
+}
+errors++;
+}
+}
+if(data.name !== undefined){
+if(typeof data.name !== "string"){
+const err6 = {instancePath:instancePath+"/name",schemaPath:"#/properties/name/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err6];
+}
+else {
+vErrors.push(err6);
+}
+errors++;
+}
+}
+if(data.department !== undefined){
+if(typeof data.department !== "string"){
+const err7 = {instancePath:instancePath+"/department",schemaPath:"#/properties/department/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err7];
+}
+else {
+vErrors.push(err7);
+}
+errors++;
+}
+}
+if(data.departmentName !== undefined){
+if(typeof data.departmentName !== "string"){
+const err8 = {instancePath:instancePath+"/departmentName",schemaPath:"#/properties/departmentName/type",keyword:"type",params:{type: "string"},message:"must be string"};
+if(vErrors === null){
+vErrors = [err8];
+}
+else {
+vErrors.push(err8);
+}
+errors++;
+}
+}
+}
+else {
+const err9 = {instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"};
+if(vErrors === null){
+vErrors = [err9];
+}
+else {
+vErrors.push(err9);
+}
+errors++;
+}
+validate14.errors = vErrors;
+return errors === 0;
+}

package/account/index.js

@@ -0,0 +1 @@
+export * from './.type/index.js'

package/application/.type/index.d.ts

@@ -0,0 +1,100 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+/**
+ * This interface was referenced by `Application`'s JSON-Schema
+ * via the `definition` "dataset".
+ */
+export type Dataset = {
+  href: string;
+  id: string;
+  title: string;
+  /**
+   * Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context.
+   */
+  key?: string;
+  schema?: Field[];
+  finalizedAt: string;
+  [k: string]: unknown;
+} & Dataset1;
+export type Dataset1 = {
+  href: string;
+  id: string;
+  title: string;
+  /**
+   * Not the id of the dataset, but a key inside this configuration object to define the role of the dataset in this context.
+   */
+  key?: string;
+  schema?: Field[];
+  finalizedAt: string;
+  [k: string]: unknown;
+} | null;
+
+export interface Application {
+  /**
+   * Globally unique identifier of the application
+   */
+  id: string;
+  /**
+   * Short title of the application
+   */
+  title: string;
+  /**
+   * The URL where this application is exposed
+   */
+  exposedUrl: string;
+  /**
+   * The URL where this resource can be fetched
+   */
+  href: string;
+  /**
+   * The URL where this application can be accessed through a websocket
+   */
+  wsUrl: string;
+  owner: AccountKeys;
+  /**
+   * 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
+   */
+  configuration: {
+    datasets?: Dataset[];
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}
+export interface AccountKeys {
+  type: "user" | "organization";
+  id: string;
+  department?: string;
+}
+/**
+ * This interface was referenced by `Application`'s JSON-Schema
+ * via the `definition` "field".
+ */
+export interface Field {
+  key: string;
+  type: string;
+  format?: string;
+  title?: string;
+  "x-originalName"?: string;
+  "x-group"?: string;
+  /**
+   * @deprecated
+   */
+  "x-refersTo"?: string | null;
+  "x-concept"?: {
+    id?: string;
+    title?: string;
+    primary?: boolean;
+    [k: string]: unknown;
+  };
+  "x-labels"?: {
+    [k: string]: string;
+  };
+  "x-labelsRestricted"?: boolean;
+  [k: string]: unknown;
+}
+
+
+export const schema: any
+        

package/application/.type/index.js

@@ -0,0 +1,161 @@
+/* eslint-disable */
+
+
+
+export const schemaExports = [
+  "types",
+  "schema"
+]
+
+export const schema = {
+  "$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"
+        }
+      }
+    }
+  }
+}

package/application/index.js

@@ -0,0 +1 @@
+export * from './.type/index.js'

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@data-fair/lib-common-types",
+  "version": "0.1.0",
+  "description": "Shared schemas and built type definitions in the data-fair stack.",
+  "main": "index.js",
+  "devDependencies": {},
+  "files": [
+    "**/*.js",
+    "**/*.d.ts"
+  ],
+  "author": "",
+  "license": "MIT",
+  "type": "module"
+}

package/session/.type/index.d.ts

@@ -0,0 +1,66 @@
+
+export const schemaExports: string[]
+
+// see https://github.com/bcherny/json-schema-to-typescript/issues/439 if some types are not exported
+export interface SessionState {
+  user?: User;
+  organization?: OrganizationMembership;
+  account?: Account;
+  accountRole?: string;
+  lang?: string;
+  dark?: boolean;
+}
+/**
+ * This interface was referenced by `SessionState`'s JSON-Schema
+ * via the `definition` "user".
+ */
+export interface User {
+  email: string;
+  id: string;
+  name: string;
+  organizations: OrganizationMembership[];
+  isAdmin?: 0 | 1;
+  adminMode?: 0 | 1;
+  asAdmin?: UserRef;
+  pd?: string;
+  ipa?: 0 | 1;
+}
+/**
+ * This interface was referenced by `SessionState`'s JSON-Schema
+ * via the `definition` "organizationMembership".
+ */
+export interface OrganizationMembership {
+  id: string;
+  name: string;
+  role: string;
+  department?: string;
+  departmentName?: string;
+  dflt?: boolean;
+}
+/**
+ * This interface was referenced by `SessionState`'s JSON-Schema
+ * via the `definition` "userRef".
+ */
+export interface UserRef {
+  id: string;
+  name: string;
+}
+/**
+ * This interface was referenced by `SessionState`'s JSON-Schema
+ * via the `definition` "account".
+ */
+export interface Account {
+  type: "user" | "organization";
+  id: string;
+  name: string;
+  department?: string;
+  departmentName?: string;
+}
+
+
+export const validate: (data: any) => data is SessionState
+export const assertValid: (data: any, options?: import('@data-fair/lib-node/validation.js').AssertValidOptions) => asserts data is SessionState
+export const returnValid: (data: any, options?: import('@data-fair/lib-node/validation.js').AssertValidOptions) => SessionState
+      
+export const schema: any
+