@vue-skuilder/common 0.1.0 → 0.1.1

package/dist/namespacer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"namespacer.js","sourceRoot":"","sources":["../src/namespacer.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,UAAU;IACd,MAAM,CAAC,sBAAsB,CAAC,QAAgB;QACnD,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;gBACrB,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;aACzB,CAAC;QACJ,CAAC;IACH,CAAC;IACM,MAAM,CAAC,kBAAkB,CAAC,gBAAiC;QAChE,OAAO,GAAG,gBAAgB,CAAC,MAAM,cAAc,gBAAgB,CAAC,SAAS,EAAE,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,OAAe;QAC7C,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEtC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;gBACrB,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;gBAC3B,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,eAA+B;QACzD,OAAO,CACL,GAAG,eAAe,CAAC,MAAM,YAAY;YACrC,GAAG,eAAe,CAAC,YAAY,IAAI,eAAe,CAAC,IAAI,EAAE,CAC1D,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,WAAmB;QACrD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;gBACrB,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;aAC5B,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,mBAAuC;QACrE,OAAO,GAAG,mBAAmB,CAAC,MAAM,aAAa,mBAAmB,CAAC,YAAY,EAAE,CAAC;IACtF,CAAC;CACF"}

package/dist/namespacer.mjs

@@ -0,0 +1,50 @@
+export class NameSpacer {
+    static getDataShapeDescriptor(shapeStr) {
+        const splitArray = shapeStr.split('.');
+        if (splitArray.length !== 3) {
+            throw new Error('shapeStr not valid');
+        }
+        else {
+            return {
+                course: splitArray[0],
+                dataShape: splitArray[2],
+            };
+        }
+    }
+    static getDataShapeString(shapeDescription) {
+        return `${shapeDescription.course}.datashape.${shapeDescription.dataShape}`;
+    }
+    static getViewDescriptor(viewStr) {
+        const splitArray = viewStr.split('.');
+        if (splitArray.length !== 4) {
+            throw new Error('viewStr not valid');
+        }
+        else {
+            return {
+                course: splitArray[0],
+                questionType: splitArray[2],
+                view: splitArray[3],
+            };
+        }
+    }
+    static getViewString(viewDescription) {
+        return (`${viewDescription.course}.question.` +
+            `${viewDescription.questionType}.${viewDescription.view}`);
+    }
+    static getQuestionDescriptor(questionStr) {
+        const splitArray = questionStr.split('.');
+        if (splitArray.length !== 3) {
+            throw new Error('questionStr not valid');
+        }
+        else {
+            return {
+                course: splitArray[0],
+                questionType: splitArray[2],
+            };
+        }
+    }
+    static getQuestionString(questionDescription) {
+        return `${questionDescription.course}.question.${questionDescription.questionType}`;
+    }
+}
+//# sourceMappingURL=namespacer.js.map

package/dist/validators.d.ts

@@ -0,0 +1,7 @@
+import { Validator } from './interfaces/Validator.js';
+interface ValidatorIndex {
+    [x: string]: Validator;
+}
+export declare const Validators: ValidatorIndex;
+export {};
+//# sourceMappingURL=validators.d.ts.map

package/dist/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGtD,UAAU,cAAc;IACtB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxB;AAED,eAAO,MAAM,UAAU,EAAE,cAiBxB,CAAC"}

package/dist/validators.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validators = void 0;
+const wire_format_js_1 = require("./wire-format.js");
+exports.Validators = {
+    NonEmptyString: {
+        instructions: '',
+        test: (input) => {
+            if (input.length !== 0) {
+                return {
+                    status: wire_format_js_1.Status.ok,
+                    msg: '',
+                };
+            }
+            else {
+                return {
+                    status: wire_format_js_1.Status.error,
+                    msg: 'Input cannot be empty',
+                };
+            }
+        },
+    },
+};
+//# sourceMappingURL=validators.js.map

package/dist/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAM1C,MAAM,CAAC,MAAM,UAAU,GAAmB;IACxC,cAAc,EAAE;QACd,YAAY,EAAE,EAAE;QAChB,IAAI,EAAE,CAAC,KAAa,EAAE,EAAE;YACtB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO;oBACL,MAAM,EAAE,MAAM,CAAC,EAAE;oBACjB,GAAG,EAAE,EAAE;iBACR,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO;oBACL,MAAM,EAAE,MAAM,CAAC,KAAK;oBACpB,GAAG,EAAE,uBAAuB;iBAC7B,CAAC;YACJ,CAAC;QACH,CAAC;KACF;CACF,CAAC"}

package/dist/validators.mjs

@@ -0,0 +1,21 @@
+import { Status } from './wire-format.mjs';
+export const Validators = {
+    NonEmptyString: {
+        instructions: '',
+        test: (input) => {
+            if (input.length !== 0) {
+                return {
+                    status: Status.ok,
+                    msg: '',
+                };
+            }
+            else {
+                return {
+                    status: Status.error,
+                    msg: 'Input cannot be empty',
+                };
+            }
+        },
+    },
+};
+//# sourceMappingURL=validators.js.map

package/dist/wire-format.d.ts

@@ -0,0 +1,141 @@
+import { DataShape } from './interfaces/DataShape.js';
+export declare enum Status {
+    awaitingResponse = "awaiting",
+    ok = "ok",
+    warning = "warning",
+    error = "error"
+}
+export interface IServerResponse {
+    errorText?: string;
+    status: Status;
+    ok: boolean;
+}
+export interface IServerRequest {
+    type: ServerRequestType;
+    user: string;
+    response: IServerResponse | null;
+    /**
+     * milliseconds to wait for a request to complete before timing out
+     */
+    timeout?: number;
+}
+export interface CreateClassroom extends IServerRequest {
+    type: ServerRequestType.CREATE_CLASSROOM;
+    data: ClassroomConfig;
+    response: {
+        status: Status;
+        ok: boolean;
+        joincode: string;
+        uuid: string;
+    } | null;
+}
+export interface DeleteClassroom extends IServerRequest {
+    type: ServerRequestType.DELETE_CLASSROOM;
+    classID: string;
+}
+export interface JoinClassroom extends IServerRequest {
+    type: ServerRequestType.JOIN_CLASSROOM;
+    user: string;
+    data: {
+        joinCode: string;
+        registerAs: 'student' | 'teacher' | 'aide' | 'admin';
+        user: string;
+    };
+    response: {
+        errorText?: string;
+        status: Status;
+        ok: boolean;
+        id_course: string;
+        course_name: string;
+    } | null;
+}
+export interface LeaveClassroom extends IServerRequest {
+    type: ServerRequestType.LEAVE_CLASSROOM;
+    data: {
+        classID: string;
+    };
+}
+type NamespacedDatashape = string;
+export interface DataShape55 {
+    name: NamespacedDatashape;
+    questionTypes: PouchDB.Core.DocumentId[];
+}
+type NamespacedQuestion = string;
+export interface QuestionType55 {
+    name: NamespacedQuestion;
+    viewList: string[];
+    dataShapeList: string[];
+}
+export interface ClassroomConfig {
+    students: string[];
+    teachers: string[];
+    name: string;
+    birthYear?: number;
+    classMeetingSchedule: string;
+    peerAssist: boolean;
+    joinCode: string;
+}
+/**
+ * metadata about a defined course
+ *
+ * Note: `courseID` is generated server-side. It is not present on
+ * new courses at the time of writing, client-side, but always
+ * present (!) when a CourseConfig is retrieved from the database
+ */
+export interface CourseConfig {
+    courseID?: string;
+    name: string;
+    description: string;
+    public: boolean;
+    deleted: boolean;
+    creator: string;
+    admins: string[];
+    moderators: string[];
+    dataShapes: DataShape55[];
+    questionTypes: QuestionType55[];
+    disambiguator?: string;
+}
+export interface CreateCourse extends IServerRequest {
+    type: ServerRequestType.CREATE_COURSE;
+    data: CourseConfig;
+    response: {
+        status: Status;
+        ok: boolean;
+        courseID: string;
+    } | null;
+}
+export interface DeleteCourse extends IServerRequest {
+    type: ServerRequestType.DELETE_COURSE;
+    courseID: string;
+}
+export interface AddCourseDataPayload {
+    courseID: string;
+    codeCourse: string;
+    shape: DataShape;
+    data: unknown;
+    author: string;
+    tags: string[];
+    uploads?: {
+        [x: string]: PouchDB.Core.FullAttachment;
+    };
+}
+export interface AddCourseData extends IServerRequest {
+    type: ServerRequestType.ADD_COURSE_DATA;
+    data: AddCourseDataPayload;
+    response: {
+        status: Status;
+        ok: boolean;
+    };
+}
+export type ServerRequest = CreateClassroom | DeleteClassroom | JoinClassroom | LeaveClassroom | CreateCourse | DeleteCourse | AddCourseData;
+export declare enum ServerRequestType {
+    CREATE_CLASSROOM = "CREATE_CLASSROOM",
+    DELETE_CLASSROOM = "DELETE_CLASSROOM",
+    JOIN_CLASSROOM = "JOIN_CLASSROOM",
+    LEAVE_CLASSROOM = "LEAVE_CLASSROOM",
+    CREATE_COURSE = "CREATE_COURSE",
+    DELETE_COURSE = "DELETE_COURSE",
+    ADD_COURSE_DATA = "ADD_COURSE_DATA"
+}
+export {};
+//# sourceMappingURL=wire-format.d.ts.map

package/dist/wire-format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire-format.d.ts","sourceRoot":"","sources":["../src/wire-format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,oBAAY,MAAM;IAChB,gBAAgB,aAAa;IAC7B,EAAE,OAAO;IACT,OAAO,YAAY;IACnB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,OAAO,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,cAAc;IACrD,IAAI,EAAE,iBAAiB,CAAC,gBAAgB,CAAC;IACzC,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,OAAO,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,IAAI,CAAC;CACV;AACD,MAAM,WAAW,eAAgB,SAAQ,cAAc;IACrD,IAAI,EAAE,iBAAiB,CAAC,gBAAgB,CAAC;IACzC,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,IAAI,EAAE,iBAAiB,CAAC,cAAc,CAAC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;QACrD,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,OAAO,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,IAAI,CAAC;CACV;AACD,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,KAAK,mBAAmB,GAAG,MAAM,CAAC;AAElC,MAAM,WAAW,WAAW;IAE1B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;CAC1C;AAED,KAAK,kBAAkB,GAAG,MAAM,CAAC;AACjC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,aAAa,EAAE,cAAc,EAAE,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,IAAI,EAAE,iBAAiB,CAAC,aAAa,CAAC;IACtC,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,OAAO,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI,CAAC;CACV;AACD,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,IAAI,EAAE,iBAAiB,CAAC,aAAa,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAA;KAAE,CAAC;CACxD;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,IAAI,EAAE,iBAAiB,CAAC,eAAe,CAAC;IACxC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,QAAQ,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,OAAO,CAAC;KACb,CAAC;CACH;AAED,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,eAAe,GACf,aAAa,GACb,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,aAAa,CAAC;AAElB,oBAAY,iBAAiB;IAC3B,gBAAgB,qBAAqB;IACrC,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;CACpC"}

package/dist/wire-format.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerRequestType = exports.Status = void 0;
+var Status;
+(function (Status) {
+    Status["awaitingResponse"] = "awaiting";
+    Status["ok"] = "ok";
+    Status["warning"] = "warning";
+    Status["error"] = "error";
+})(Status || (exports.Status = Status = {}));
+var ServerRequestType;
+(function (ServerRequestType) {
+    ServerRequestType["CREATE_CLASSROOM"] = "CREATE_CLASSROOM";
+    ServerRequestType["DELETE_CLASSROOM"] = "DELETE_CLASSROOM";
+    ServerRequestType["JOIN_CLASSROOM"] = "JOIN_CLASSROOM";
+    ServerRequestType["LEAVE_CLASSROOM"] = "LEAVE_CLASSROOM";
+    ServerRequestType["CREATE_COURSE"] = "CREATE_COURSE";
+    ServerRequestType["DELETE_COURSE"] = "DELETE_COURSE";
+    ServerRequestType["ADD_COURSE_DATA"] = "ADD_COURSE_DATA";
+})(ServerRequestType || (exports.ServerRequestType = ServerRequestType = {}));
+//# sourceMappingURL=wire-format.js.map

package/dist/wire-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire-format.js","sourceRoot":"","sources":["../src/wire-format.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,MAKX;AALD,WAAY,MAAM;IAChB,uCAA6B,CAAA;IAC7B,mBAAS,CAAA;IACT,6BAAmB,CAAA;IACnB,yBAAe,CAAA;AACjB,CAAC,EALW,MAAM,KAAN,MAAM,QAKjB;AA+ID,MAAM,CAAN,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,0DAAqC,CAAA;IACrC,0DAAqC,CAAA;IACrC,sDAAiC,CAAA;IACjC,wDAAmC,CAAA;IACnC,oDAA+B,CAAA;IAC/B,oDAA+B,CAAA;IAC/B,wDAAmC,CAAA;AACrC,CAAC,EARW,iBAAiB,KAAjB,iBAAiB,QAQ5B"}

package/dist/wire-format.mjs

@@ -0,0 +1,18 @@
+export var Status;
+(function (Status) {
+    Status["awaitingResponse"] = "awaiting";
+    Status["ok"] = "ok";
+    Status["warning"] = "warning";
+    Status["error"] = "error";
+})(Status || (Status = {}));
+export var ServerRequestType;
+(function (ServerRequestType) {
+    ServerRequestType["CREATE_CLASSROOM"] = "CREATE_CLASSROOM";
+    ServerRequestType["DELETE_CLASSROOM"] = "DELETE_CLASSROOM";
+    ServerRequestType["JOIN_CLASSROOM"] = "JOIN_CLASSROOM";
+    ServerRequestType["LEAVE_CLASSROOM"] = "LEAVE_CLASSROOM";
+    ServerRequestType["CREATE_COURSE"] = "CREATE_COURSE";
+    ServerRequestType["DELETE_COURSE"] = "DELETE_COURSE";
+    ServerRequestType["ADD_COURSE_DATA"] = "ADD_COURSE_DATA";
+})(ServerRequestType || (ServerRequestType = {}));
+//# sourceMappingURL=wire-format.js.map

package/package.json

@@ -1,10 +1,9 @@
 {
     "name": "@vue-skuilder/common",
-    "private": false,
     "publishConfig": {
-      "access": "public"
+        "access": "public"
     },
-    "version": "0.1.0",
+    "version": "0.1.1",
     "type": "module",
     "main": "dist/index.js",
     "module": "dist/index.mjs",