@osaas/types 0.2.0

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './schema/Tenant';
+export * from './schema/User';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}

package/lib/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./schema/Tenant"), exports);
+__exportStar(require("./schema/User"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,gDAA8B"}

package/lib/schema/Tenant.d.ts

@@ -0,0 +1,66 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import { Schema } from 'mongoose';
+export declare const BILLING_OPTIONS: readonly ["paypal", "invoice"];
+export declare const TenantSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, {
+    _id: string;
+    enabled: boolean;
+    billing: "paypal" | "invoice";
+    repositories: {
+        _id: string;
+        type: "github";
+    }[];
+    schemaVersion: number;
+    name?: string | undefined;
+    description?: string | undefined;
+    avatarUrl?: string | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    _id: string;
+    enabled: boolean;
+    billing: "paypal" | "invoice";
+    repositories: {
+        _id: string;
+        type: "github";
+    }[];
+    schemaVersion: number;
+    name?: string | undefined;
+    description?: string | undefined;
+    avatarUrl?: string | undefined;
+}>> & import("mongoose").FlatRecord<{
+    _id: string;
+    enabled: boolean;
+    billing: "paypal" | "invoice";
+    repositories: {
+        _id: string;
+        type: "github";
+    }[];
+    schemaVersion: number;
+    name?: string | undefined;
+    description?: string | undefined;
+    avatarUrl?: string | undefined;
+}> & Required<{
+    _id: string;
+}>>;
+//# sourceMappingURL=Tenant.d.ts.map

package/lib/schema/Tenant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tenant.d.ts","sourceRoot":"","sources":["../../src/schema/Tenant.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAkB,MAAM,UAAU,CAAC;AAKlD,eAAO,MAAM,eAAe,gCAAiC,CAAC;AAM9D,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DvB,CAAC"}

package/lib/schema/Tenant.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantSchema = exports.BILLING_OPTIONS = void 0;
+const mongoose_1 = require("mongoose");
+const util_1 = require("./util");
+const SCHEMA_VERSION = 4;
+exports.BILLING_OPTIONS = ['paypal', 'invoice'];
+function tenantIdValidator(_id) {
+    return _id.length && _id.length <= 10 && /^[a-z]([a-z0-9])*$/.test(_id);
+}
+exports.TenantSchema = new mongoose_1.Schema({
+    _id: {
+        type: String,
+        required: true,
+        default: util_1.generateTenantId,
+        validate: {
+            validator: tenantIdValidator,
+            message: (props) => `${props.value} is not a valid id. Max 10 characters, start with a letter, and only contains lowercase letters and numbers.`
+        }
+    },
+    enabled: { type: Boolean, required: true, default: true },
+    name: {
+        type: String,
+        required: false,
+        index: {
+            unique: true,
+            collation: {
+                // case insensitive
+                locale: 'simple',
+                strength: 1
+            },
+            // only index documents that have a name field
+            partialFilterExpression: { name: { $type: 'string' } }
+        }
+    },
+    description: {
+        type: String,
+        required: false
+    },
+    avatarUrl: {
+        type: String,
+        required: false
+    },
+    billing: {
+        type: String,
+        enum: ['paypal', 'invoice'],
+        required: true,
+        default: 'invoice'
+    },
+    repositories: [
+        {
+            type: {
+                type: String,
+                enum: ['github'],
+                required: true,
+                default: 'github'
+            },
+            _id: {
+                type: String,
+                required: true
+            }
+        }
+    ],
+    schemaVersion: {
+        type: Number,
+        required: true,
+        default: SCHEMA_VERSION
+    }
+});
+//# sourceMappingURL=Tenant.js.map

package/lib/schema/Tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tenant.js","sourceRoot":"","sources":["../../src/schema/Tenant.ts"],"names":[],"mappings":";;;AAAA,uCAAkD;AAClD,iCAA0C;AAE1C,MAAM,cAAc,GAAG,CAAC,CAAC;AAEZ,QAAA,eAAe,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC;AAE9D,SAAS,iBAAiB,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,EAAE,IAAI,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1E,CAAC;AAEY,QAAA,YAAY,GAAG,IAAI,iBAAM,CAAC;IACrC,GAAG,EAAE;QACH,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,uBAAgB;QACzB,QAAQ,EAAE;YACR,SAAS,EAAE,iBAAiB;YAC5B,OAAO,EAAE,CAAC,KAAqB,EAAE,EAAE,CACjC,GAAG,KAAK,CAAC,KAAK,8GAA8G;SAC/H;KACF;IACD,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;IACzD,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE;YACL,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE;gBACT,mBAAmB;gBACnB,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,CAAC;aACZ;YACD,8CAA8C;YAC9C,uBAAuB,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;SACvD;KACF;IACD,WAAW,EAAE;QACX,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,KAAK;KAChB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC3B,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,SAAS;KACnB;IACD,YAAY,EAAE;QACZ;YACE,IAAI,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,CAAC,QAAQ,CAAC;gBAChB,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,QAAQ;aAClB;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,MAAM;gBACZ,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IACD,aAAa,EAAE;QACb,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,cAAc;KACxB;CACF,CAAC,CAAC"}

package/lib/schema/User.d.ts

@@ -0,0 +1,88 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+import { Schema } from 'mongoose';
+export type UserRole = 'osaas-admin' | 'user';
+export type TenantUserRole = 'owner' | 'admin' | 'member';
+export declare const UserSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, {
+    paypal: {
+        payerId?: string | undefined;
+    };
+    schemaVersion: number;
+    role: UserRole;
+    email: string;
+    tenants: {
+        _id: string;
+        role: "owner" | "admin" | "member";
+        personalAccessToken: string;
+    }[];
+    notifications: import("mongoose").Types.DocumentArray<{
+        message: string;
+        link: string;
+    }>;
+    favoriteServices: string[];
+    lastAccessed?: Date | undefined;
+    emailVerified?: Date | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    paypal: {
+        payerId?: string | undefined;
+    };
+    schemaVersion: number;
+    role: UserRole;
+    email: string;
+    tenants: {
+        _id: string;
+        role: "owner" | "admin" | "member";
+        personalAccessToken: string;
+    }[];
+    notifications: import("mongoose").Types.DocumentArray<{
+        message: string;
+        link: string;
+    }>;
+    favoriteServices: string[];
+    lastAccessed?: Date | undefined;
+    emailVerified?: Date | undefined;
+}>> & import("mongoose").FlatRecord<{
+    paypal: {
+        payerId?: string | undefined;
+    };
+    schemaVersion: number;
+    role: UserRole;
+    email: string;
+    tenants: {
+        _id: string;
+        role: "owner" | "admin" | "member";
+        personalAccessToken: string;
+    }[];
+    notifications: import("mongoose").Types.DocumentArray<{
+        message: string;
+        link: string;
+    }>;
+    favoriteServices: string[];
+    lastAccessed?: Date | undefined;
+    emailVerified?: Date | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+}>;
+//# sourceMappingURL=User.d.ts.map

package/lib/schema/User.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../src/schema/User.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;AAC9C,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAW1D,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+CrB,CAAC"}

package/lib/schema/User.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserSchema = void 0;
+const mongoose_1 = require("mongoose");
+const SCHEMA_VERSION = 5;
+const UserRoles = ['osaas-admin', 'user'];
+const NotificationSchema = new mongoose_1.Schema({
+    message: { type: String, required: true },
+    link: { type: String, required: true }
+});
+exports.UserSchema = new mongoose_1.Schema({
+    lastAccessed: {
+        type: Date
+    },
+    emailVerified: {
+        type: Date
+    },
+    role: {
+        type: String,
+        required: true,
+        enum: UserRoles,
+        default: 'user'
+    },
+    email: {
+        type: String,
+        required: true,
+        index: {
+            unique: true
+        }
+    },
+    paypal: {
+        type: {
+            payerId: { type: String }
+        },
+        required: true,
+        default: {},
+        _id: false
+    },
+    tenants: [
+        {
+            _id: { type: String, ref: 'Tenant', required: true },
+            role: {
+                type: String,
+                enum: ['owner', 'admin', 'member'],
+                required: true,
+                default: 'member'
+            },
+            personalAccessToken: { type: String, required: true }
+        }
+    ],
+    notifications: [NotificationSchema],
+    favoriteServices: [{ type: String, required: true, default: [] }],
+    schemaVersion: {
+        type: Number,
+        required: true,
+        default: SCHEMA_VERSION
+    }
+});
+//# sourceMappingURL=User.js.map

package/lib/schema/User.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.js","sourceRoot":"","sources":["../../src/schema/User.ts"],"names":[],"mappings":";;;AAAA,uCAAkC;AAKlC,MAAM,cAAc,GAAG,CAAC,CAAC;AAEzB,MAAM,SAAS,GAAe,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AAEtD,MAAM,kBAAkB,GAAG,IAAI,iBAAM,CAAC;IACpC,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACzC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;CACvC,CAAC,CAAC;AAEU,QAAA,UAAU,GAAG,IAAI,iBAAM,CAAC;IACnC,YAAY,EAAE;QACZ,IAAI,EAAE,IAAI;KACX;IACD,aAAa,EAAE;QACb,IAAI,EAAE,IAAI;KACX;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;KAChB;IACD,KAAK,EAAE;QACL,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE;YACL,MAAM,EAAE,IAAI;SACb;KACF;IACD,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SAC1B;QACD,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,KAAK;KACX;IACD,OAAO,EAAE;QACP;YACE,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;YACpD,IAAI,EAAE;gBACJ,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;gBAClC,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,QAAQ;aAClB;YACD,mBAAmB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;SACtD;KACF;IACD,aAAa,EAAE,CAAC,kBAAkB,CAAC;IACnC,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACjE,aAAa,EAAE;QACb,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,cAAc;KACxB;CACF,CAAC,CAAC"}

package/lib/schema/util.d.ts

@@ -0,0 +1,2 @@
+export declare function generateTenantId(): string;
+//# sourceMappingURL=util.d.ts.map

package/lib/schema/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/schema/util.ts"],"names":[],"mappings":"AAMA,wBAAgB,gBAAgB,WAG/B"}

package/lib/schema/util.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTenantId = void 0;
+const crypto_1 = require("crypto");
+const nanoid_1 = require("nanoid");
+const letterOnlyNanoid = (0, nanoid_1.customAlphabet)('abcdefghijklmnopqrstuvwxyz', 1);
+const nanoid = (0, nanoid_1.customAlphabet)('0123456789abcdefghijklmnopqrstuvwxyz', 9);
+function generateTenantId() {
+    const length = (0, crypto_1.randomInt)(8, 10);
+    return `${letterOnlyNanoid()}${nanoid(length)}`;
+}
+exports.generateTenantId = generateTenantId;
+//# sourceMappingURL=util.js.map

package/lib/schema/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/schema/util.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,mCAAwC;AAExC,MAAM,gBAAgB,GAAG,IAAA,uBAAc,EAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC;AACzE,MAAM,MAAM,GAAG,IAAA,uBAAc,EAAC,sCAAsC,EAAE,CAAC,CAAC,CAAC;AAEzE,SAAgB,gBAAgB;IAC9B,MAAM,MAAM,GAAG,IAAA,kBAAS,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChC,OAAO,GAAG,gBAAgB,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;AAClD,CAAC;AAHD,4CAGC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@osaas/types",
+  "version": "0.2.0",
+  "description": "OSaaS shared types",
+  "author": "Jonas Birmé <jonas.birme@eyevinn.se>",
+  "homepage": "https://github.com/Eyevinn/osaas-lib-util#readme",
+  "license": "ISC",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Eyevinn/osaas-lib-util.git"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint .",
+    "pretty": "prettier --check --ignore-unknown .",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "jest --passWithNoTests"
+  },
+  "bugs": {
+    "url": "https://github.com/Eyevinn/osaas-lib-util/issues"
+  },
+  "dependencies": {
+    "mongoose": "^7.4.3",
+    "nanoid": "^5.0.2"
+  },
+  "gitHead": "86fc981fb6ae9f0dffffadbb9a4babb5065d3098"
+}