@spotto/contract 0.0.5

package/dist/types/users/constants.d.ts

@@ -0,0 +1,3 @@
+export declare type UserType = 'INTERNAL' | 'EXTERNAL';
+export declare const USER_TYPES: UserType[];
+export declare const internalEmailSchema: import("joi").AlternativesSchema;

package/dist/types/users/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.internalEmailSchema = exports.USER_TYPES = void 0;
+const joi_1 = require("joi");
+const shared_1 = require("../shared");
+exports.USER_TYPES = ['INTERNAL', 'EXTERNAL'];
+exports.internalEmailSchema = joi_1.when('type', {
+    is: 'INTERNAL',
+    then: shared_1.xString.email().required(),
+    otherwise: joi_1.forbidden(),
+});
+//# sourceMappingURL=constants.js.map

package/dist/types/users/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/types/users/constants.ts"],"names":[],"mappings":";;;AAAA,6BAAsC;AACtC,sCAAoC;AAIvB,QAAA,UAAU,GAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;AAElD,QAAA,mBAAmB,GAAG,UAAI,CAAC,MAAM,EAAE;IAC9C,EAAE,EAAE,UAAU;IACd,IAAI,EAAE,gBAAO,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,eAAS,EAAE;CACvB,CAAC,CAAC"}

package/dist/types/users/current.d.ts

@@ -0,0 +1,14 @@
+import { IEntityMeta, IEmbeddedEntity } from '../shared';
+export interface EmbeddedRole extends IEmbeddedEntity {
+    permissions: string[];
+}
+export interface CurrentUserResponse {
+    id: string;
+    email: string;
+    name: string;
+    role: EmbeddedRole;
+    organisation: IEmbeddedEntity;
+    meta?: IEntityMeta;
+}
+export declare const currentUserResponseSchema: import("joi").ObjectSchema<import("./[id]").UpdateUserResponse>;
+export declare const validateCurrentUserResponse: (payload: any) => CurrentUserResponse;

package/dist/types/users/current.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCurrentUserResponse = exports.currentUserResponseSchema = void 0;
+const shared_1 = require("../shared");
+const _id_1 = require("./[id]");
+const get_1 = require("../roles/[id]/get");
+exports.currentUserResponseSchema = _id_1.getUserResponseSchema.append({
+    role: shared_1.embeddedEntitySchema()
+        .append({
+        permissions: get_1.permissionsSchema,
+    })
+        .required(),
+});
+const validateCurrentUserResponse = (payload) => shared_1.validateJoiSchema(exports.currentUserResponseSchema, payload);
+exports.validateCurrentUserResponse = validateCurrentUserResponse;
+//# sourceMappingURL=current.js.map

package/dist/types/users/current.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"current.js","sourceRoot":"","sources":["../../../src/types/users/current.ts"],"names":[],"mappings":";;;AAAA,sCAKmB;AACnB,gCAA+C;AAC/C,2CAAsD;AA4BzC,QAAA,yBAAyB,GAAG,2BAAqB,CAAC,MAAM,CAAC;IACpE,IAAI,EAAE,6BAAoB,EAAgB;SACvC,MAAM,CAAC;QACN,WAAW,EAAE,uBAAiB;KAC/B,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAEI,MAAM,2BAA2B,GAAG,CAAC,OAAY,EAAE,EAAE,CAC1D,0BAAiB,CAAsB,iCAAyB,EAAE,OAAO,CAAC,CAAC;AADhE,QAAA,2BAA2B,+BACqC"}

package/dist/types/users/get/index.d.ts

@@ -0,0 +1,2 @@
+export * from './query';
+export * from './response';

package/dist/types/users/get/index.js

@@ -0,0 +1,15 @@
+"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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./query"), exports);
+__exportStar(require("./response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/users/get/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/users/get/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAAwB;AACxB,6CAA2B"}

package/dist/types/users/get/query.d.ts

@@ -0,0 +1,15 @@
+import { StandardSortFields, SortOrders } from '../../shared';
+import { UserType } from '../constants';
+export declare type UserEmbedField = 'meta';
+export interface GetUsersQuery {
+    page?: number;
+    limit?: number;
+    ids?: string[];
+    role?: string[];
+    type?: UserType;
+    sort?: StandardSortFields;
+    sortOrder?: SortOrders;
+    embed?: Array<UserEmbedField>;
+}
+export declare const getUsersQuerySchema: import("joi").ObjectSchema<GetUsersQuery>;
+export declare const validateGetUsersQuery: (payload: any) => GetUsersQuery | null;

package/dist/types/users/get/query.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateGetUsersQuery = exports.getUsersQuerySchema = void 0;
+const joi_1 = require("joi");
+const shared_1 = require("../../shared");
+const constants_1 = require("../constants");
+exports.getUsersQuerySchema = joi_1.object({
+    page: shared_1.xInt,
+    limit: shared_1.xInt,
+    ids: shared_1.xArrayOfObjectIds(true),
+    role: shared_1.xArrayOfObjectIds(true),
+    type: shared_1.xStringIsOneOf(...constants_1.USER_TYPES),
+    sort: shared_1.xStandardSortFields,
+    sortOrder: shared_1.xSortOrder,
+    embed: shared_1.xArrayOfRequiredStrings('meta'),
+});
+const validateGetUsersQuery = (payload) => shared_1.validateOptionalJoiSchema(exports.getUsersQuerySchema, payload);
+exports.validateGetUsersQuery = validateGetUsersQuery;
+//# sourceMappingURL=query.js.map

package/dist/types/users/get/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../src/types/users/get/query.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAC7B,yCAUsB;AACtB,4CAAoD;AA+CvC,QAAA,mBAAmB,GAAG,YAAM,CAAgB;IAEvD,IAAI,EAAE,aAAI;IACV,KAAK,EAAE,aAAI;IAGX,GAAG,EAAE,0BAAiB,CAAC,IAAI,CAAC;IAC5B,IAAI,EAAE,0BAAiB,CAAC,IAAI,CAAC;IAC7B,IAAI,EAAE,uBAAc,CAAC,GAAG,sBAAU,CAAC;IAGnC,IAAI,EAAE,4BAAmB;IACzB,SAAS,EAAE,mBAAU;IAGrB,KAAK,EAAE,gCAAuB,CAAC,MAAM,CAAC;CACvC,CAAC,CAAC;AAEI,MAAM,qBAAqB,GAAG,CAAC,OAAY,EAAE,EAAE,CACpD,kCAAyB,CAAgB,2BAAmB,EAAE,OAAO,CAAC,CAAC;AAD5D,QAAA,qBAAqB,yBACuC"}

package/dist/types/users/get/response.d.ts

@@ -0,0 +1,9 @@
+import { GetUsersQuery } from './query';
+import { GetUserResponse } from '../[id]/get';
+export interface GetUsersResponse {
+    query: GetUsersQuery | null;
+    total: number;
+    items: GetUserResponse[];
+}
+export declare const getUsersResponseSchema: import("joi").ObjectSchema<GetUsersResponse>;
+export declare const validateGetUsersResponse: (payload: any) => GetUsersResponse;

package/dist/types/users/get/response.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateGetUsersResponse = exports.getUsersResponseSchema = void 0;
+const joi_1 = require("joi");
+const query_1 = require("./query");
+const get_1 = require("../[id]/get");
+const shared_1 = require("../../shared");
+exports.getUsersResponseSchema = joi_1.object({
+    query: query_1.getUsersQuerySchema.allow(null).required(),
+    total: shared_1.xInt.required(),
+    items: shared_1.xArray(get_1.getUserResponseSchema, 'id').required(),
+});
+const validateGetUsersResponse = (payload) => shared_1.validateJoiSchema(exports.getUsersResponseSchema, payload);
+exports.validateGetUsersResponse = validateGetUsersResponse;
+//# sourceMappingURL=response.js.map

package/dist/types/users/get/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/types/users/get/response.ts"],"names":[],"mappings":";;;AAAA,6BAA6B;AAC7B,mCAA6D;AAC7D,qCAAqE;AACrE,yCAA+D;AAgBlD,QAAA,sBAAsB,GAAG,YAAM,CAAmB;IAE7D,KAAK,EAAE,2BAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;IACjD,KAAK,EAAE,aAAI,CAAC,QAAQ,EAAE;IACtB,KAAK,EAAE,eAAM,CAAC,2BAAqB,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC;AAEI,MAAM,wBAAwB,GAAG,CAAC,OAAY,EAAE,EAAE,CACvD,0BAAiB,CAAmB,8BAAsB,EAAE,OAAO,CAAC,CAAC;AAD1D,QAAA,wBAAwB,4BACkC"}

package/dist/types/users/index.d.ts

@@ -0,0 +1,5 @@
+export * from './constants';
+export * from './current';
+export * from './post';
+export * from './get';
+export * from './[id]';

package/dist/types/users/index.js

@@ -0,0 +1,18 @@
+"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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./current"), exports);
+__exportStar(require("./post"), exports);
+__exportStar(require("./get"), exports);
+__exportStar(require("./[id]"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/users/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,4CAA0B;AAC1B,yCAAuB;AACvB,wCAAsB;AACtB,yCAAuB"}

package/dist/types/users/post/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request';
+export * from './response';

package/dist/types/users/post/index.js

@@ -0,0 +1,15 @@
+"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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/users/post/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/users/post/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,6CAA2B"}

package/dist/types/users/post/request.d.ts

@@ -0,0 +1,15 @@
+export interface BasePostUserRequest {
+    name: string;
+    role: string;
+}
+export interface PostExternalUserRequest extends BasePostUserRequest {
+    type: 'EXTERNAL';
+}
+export interface PostInternalUserRequest extends BasePostUserRequest {
+    type: 'INTERNAL';
+    email: string;
+    password?: string;
+}
+export declare type PostUserRequest = PostExternalUserRequest | PostInternalUserRequest;
+export declare const postUserRequestSchema: import("joi").ObjectSchema<PostUserRequest>;
+export declare const validatePostUserRequest: (payload: any) => PostUserRequest;

package/dist/types/users/post/request.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePostUserRequest = exports.postUserRequestSchema = void 0;
+const joi_1 = require("joi");
+const shared_1 = require("../../shared");
+const constants_1 = require("../constants");
+exports.postUserRequestSchema = joi_1.object({
+    name: shared_1.xString.required(),
+    role: shared_1.xObjectId.required(),
+    type: shared_1.xStringIsOneOf(...constants_1.USER_TYPES).required(),
+    email: constants_1.internalEmailSchema,
+    password: joi_1.when('type', {
+        is: 'INTERNAL',
+        then: joi_1.string().min(6),
+        otherwise: joi_1.forbidden(),
+    }),
+});
+const validatePostUserRequest = (payload) => shared_1.validateJoiSchema(exports.postUserRequestSchema, payload);
+exports.validatePostUserRequest = validatePostUserRequest;
+//# sourceMappingURL=request.js.map

package/dist/types/users/post/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../../src/types/users/post/request.ts"],"names":[],"mappings":";;;AAAA,6BAAsD;AACtD,yCAKsB;AACtB,4CAA+D;AAgClD,QAAA,qBAAqB,GAAG,YAAM,CAAkB;IAE3D,IAAI,EAAE,gBAAO,CAAC,QAAQ,EAAE;IACxB,IAAI,EAAE,kBAAS,CAAC,QAAQ,EAAE;IAC1B,IAAI,EAAE,uBAAc,CAAC,GAAG,sBAAU,CAAC,CAAC,QAAQ,EAAE;IAG9C,KAAK,EAAE,+BAAmB;IAK1B,QAAQ,EAAE,UAAI,CAAC,MAAM,EAAE;QACrB,EAAE,EAAE,UAAU;QACd,IAAI,EAAE,YAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QACrB,SAAS,EAAE,eAAS,EAAE;KACvB,CAAC;CACH,CAAC,CAAC;AAEI,MAAM,uBAAuB,GAAG,CAAC,OAAY,EAAE,EAAE,CACtD,0BAAiB,CAAkB,6BAAqB,EAAE,OAAO,CAAC,CAAC;AADxD,QAAA,uBAAuB,2BACiC"}

package/dist/types/users/post/response.d.ts

@@ -0,0 +1 @@
+export { GetUserResponse as PostUserResponse, validateGetUserResponse as validatePostUserResponse, } from '../[id]/get';

package/dist/types/users/post/response.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePostUserResponse = void 0;
+var get_1 = require("../[id]/get");
+Object.defineProperty(exports, "validatePostUserResponse", { enumerable: true, get: function () { return get_1.validateGetUserResponse; } });
+//# sourceMappingURL=response.js.map

package/dist/types/users/post/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../src/types/users/post/response.ts"],"names":[],"mappings":";;;AAAA,mCAGqB;AADnB,+GAAA,uBAAuB,OAA4B"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@spotto/contract",
+  "license": "ISC",
+  "version": "0.0.5",
+  "description": "Spotto's API Contract",
+  "main": "./dist/index.js",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "rm -r dist && tsc --project tsconfig.types.json",
+    "clean": "rm -rf node_modules && rm -rf yarn.lock",
+    "test": "jest src",
+    "start": "spot docs src/api.ts",
+    "generate": "spot generate -c src/api.ts",
+    "lint": "spot lint src/api.ts",
+    "validate": "spot validate src/api.ts"
+  },
+  "dependencies": {
+    "@airtasker/spot": "^1.4.0",
+    "@spotto/core-lib": "^0.0.5",
+    "geojson-validation": "^1.0.2",
+    "joi": "^17.2.1",
+    "qs": "^6.9.4"
+  },
+  "gitHead": "6c5a8b3b50ddc2e9b6f5ac0b722ad93a1a546f57"
+}