@ordinlabs/wsm-types 2.2.2

package/dist/project.d.ts

@@ -0,0 +1,91 @@
+import * as k8s from '@kubernetes/client-node';
+import { VirtualServer } from './nginx-ingress-types';
+import { StoredParamValues } from '@ordinlabs/wsm-common/dist/param-types';
+import { ProjectRole } from './rbac';
+import { WorkspaceTemplateId } from './workspace';
+import { HasHttpAccessRules } from './accessRules';
+import { HasId, HasKubeStructureVersion, NamedDataObject, UnsavedDataObject } from './base';
+import { Developer } from './developer';
+import { UserAssociation, UserAssociationId } from './memberships';
+import { PublicKey } from './publicKey';
+export type ProjectTemplateId = 'm2' | 'basicPhp';
+export type MageRunType = 'store' | 'website';
+export type MageConfig = {
+    name: string;
+    runType: MageRunType;
+    runCode: string;
+};
+export type SubdomainConfig = MageConfig & {
+    useStorePaths?: boolean;
+    storePaths?: MageConfig[];
+};
+export type ProjectInfo = NamedDataObject & {
+    projectTemplate: ProjectTemplateId;
+    workspaceTemplate: WorkspaceTemplateId;
+    lastSeen?: number;
+};
+export type MyProjectInfo = ProjectInfo & {
+    role?: ProjectRole;
+};
+export type RepositorySpec = {
+    type?: 'git';
+    url: string;
+};
+export type Project = ProjectInfo & HasHttpAccessRules & HasKubeStructureVersion & {
+    subdomains: SubdomainConfig[];
+    projectParams: StoredParamValues<any>;
+    workspaceDefaultVolumeSize?: number;
+    workspaceParams: StoredParamValues<any>;
+    repositories: RepositorySpec[];
+    keyPairIds: string[];
+    namespace: string;
+    efsFolder: string;
+    nfsFolderSize: number;
+};
+export type UnsavedProject = Omit<UnsavedDataObject<Project>, 'namespace' | 'efsFolder' | 'kubeStructureVersion'>;
+export declare function isUnsavedProject(obj: any): obj is UnsavedProject;
+export declare function isProject(obj: any): obj is Project;
+export type ProjectInspection = {
+    project: Project;
+    resolvedParams: object;
+    ns?: k8s.V1Namespace;
+    ebsVolumeClaims?: k8s.V1PersistentVolumeClaim[];
+    oldSharedVolumeClaim?: k8s.V1PersistentVolumeClaim;
+    oldSharedVolume?: k8s.V1PersistentVolume;
+    deployment: k8s.V1Deployment;
+    currentPod?: k8s.V1Pod | null;
+    service?: k8s.V1Service;
+    sshConfig?: k8s.V1ConfigMap;
+    virtualServers?: VirtualServer[];
+    publicKeys?: PublicKey[];
+    events?: k8s.CoreV1Event[];
+};
+export type UserProjectRoleId = UserAssociationId & {
+    projectId: string;
+};
+export type UserProjectRole = UserAssociation<ProjectRole, UserProjectRoleId>;
+export type GitRepoRefInfo = {
+    type: 'tag' | 'note' | 'branch' | 'unknown';
+    name: string;
+    hash: string;
+};
+export type GetProjectRepoRefsResult = {
+    ok: true;
+    refs: GitRepoRefInfo[];
+} | {
+    ok: false;
+    error: string;
+};
+export declare function isUserProjectRoleId(obj: any): obj is UserProjectRoleId;
+export type ProjectMember = UserProjectRole & {
+    developer?: Developer;
+    fromGroup?: string;
+};
+export declare function isUserProjectRole(obj: any): obj is UserProjectRole;
+export type GroupProjectId = {
+    groupId: string;
+    projectId: string;
+};
+export type GroupProject = HasId<GroupProjectId>;
+export declare function isGroupProjectId(obj: any): obj is GroupProjectId;
+export declare function isGroupProject(obj: any): obj is GroupProject;

package/dist/project.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGroupProject = exports.isGroupProjectId = exports.isUserProjectRole = exports.isUserProjectRoleId = exports.isProject = exports.isUnsavedProject = void 0;
+const base_1 = require("./base");
+function isUnsavedProject(obj) {
+    if (!(0, base_1.isUnsavedEntity)(obj))
+        return false;
+    const p = obj;
+    return Array.isArray(p.subdomains) && p.subdomains.length >= 1;
+}
+exports.isUnsavedProject = isUnsavedProject;
+function isProject(obj) {
+    if (!(0, base_1.isEntity)(obj) || !isUnsavedProject(obj))
+        return false;
+    // TODO: validate optional/defaulted fields
+    return true;
+}
+exports.isProject = isProject;
+function isUserProjectRoleId(obj) {
+    return (typeof (obj === null || obj === void 0 ? void 0 : obj.userId) === 'string' && typeof (obj === null || obj === void 0 ? void 0 : obj.projectId) === 'string');
+}
+exports.isUserProjectRoleId = isUserProjectRoleId;
+function isUserProjectRole(obj) {
+    return isUserProjectRoleId(obj.id) && typeof (obj === null || obj === void 0 ? void 0 : obj.role) === 'string';
+}
+exports.isUserProjectRole = isUserProjectRole;
+function isGroupProjectId(obj) {
+    return (obj &&
+        typeof obj.groupId === 'string' &&
+        typeof obj.projectId === 'string');
+}
+exports.isGroupProjectId = isGroupProjectId;
+function isGroupProject(obj) {
+    return obj && isGroupProjectId(obj.id);
+}
+exports.isGroupProject = isGroupProject;
+//# sourceMappingURL=project.js.map

package/dist/project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../src/project.ts"],"names":[],"mappings":";;;AAMA,iCAOgB;AA0DhB,SAAgB,gBAAgB,CAAC,GAAQ;IACrC,IAAI,CAAC,IAAA,sBAAe,EAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACxC,MAAM,CAAC,GAAG,GAAqB,CAAC;IAChC,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC;AACnE,CAAC;AAJD,4CAIC;AAED,SAAgB,SAAS,CAAC,GAAQ;IAC9B,IAAI,CAAC,IAAA,eAAQ,EAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3D,2CAA2C;IAC3C,OAAO,IAAI,CAAC;AAChB,CAAC;AAJD,8BAIC;AAmDD,SAAgB,mBAAmB,CAAC,GAAQ;IACxC,OAAO,CACH,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,CAAA,KAAK,QAAQ,IAAI,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,CAAA,KAAK,QAAQ,CACxE,CAAC;AACN,CAAC;AAJD,kDAIC;AAOD,SAAgB,iBAAiB,CAAC,GAAQ;IACtC,OAAO,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAA,KAAK,QAAQ,CAAC;AACxE,CAAC;AAFD,8CAEC;AAUD,SAAgB,gBAAgB,CAAC,GAAQ;IACrC,OAAO,CACH,GAAG;QACH,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;QAC/B,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ,CACpC,CAAC;AACN,CAAC;AAND,4CAMC;AAED,SAAgB,cAAc,CAAC,GAAQ;IACnC,OAAO,GAAG,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAC3C,CAAC;AAFD,wCAEC"}

package/dist/publicKey.d.ts

@@ -0,0 +1,17 @@
+import { DataObject } from './base';
+export type PublicKey = DataObject & {
+    publicKey: string;
+    algorithm: string;
+};
+export type AddKeyPairRequest = {
+    projectId: string;
+    mode: 'replace' | 'add';
+};
+export type TestGitAccessRequest = {
+    keyId: string;
+    repoUrl: string;
+};
+export type TestGitAccessResponse = {
+    ok: boolean;
+    error?: string;
+};

package/dist/publicKey.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=publicKey.js.map

package/dist/publicKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicKey.js","sourceRoot":"","sources":["../src/publicKey.ts"],"names":[],"mappings":""}

package/dist/rbac.d.ts

@@ -0,0 +1,3 @@
+export type ApplicationRole = 'user' | 'projectManager' | 'admin' | 'blocked';
+export type ProjectRole = 'member' | 'admin' | 'owner' | 'guest';
+export type GroupRole = 'member' | 'admin' | 'owner';

package/dist/rbac.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rbac.js.map

package/dist/rbac.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rbac.js","sourceRoot":"","sources":["../src/rbac.ts"],"names":[],"mappings":""}

package/dist/reflection.d.ts

@@ -0,0 +1,7 @@
+import { Workspace } from './workspace';
+import { Developer } from './developer';
+import { Project } from './project';
+import { Group } from './group';
+export type Entity = Developer | Project | Workspace | Group;
+export type EntityType = 'project' | 'workspace' | 'developer' | 'group';
+export declare function getEntityType(obj: any): EntityType | undefined;

package/dist/reflection.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntityType = void 0;
+const workspace_1 = require("./workspace");
+const developer_1 = require("./developer");
+const project_1 = require("./project");
+const group_1 = require("./group");
+function getEntityType(obj) {
+    if ((0, workspace_1.isUnsavedWorkspace)(obj)) {
+        return 'workspace';
+    }
+    else if ((0, developer_1.isUnsavedDeveloper)(obj)) {
+        return 'developer';
+    }
+    else if ((0, project_1.isUnsavedProject)(obj)) {
+        return 'project';
+    }
+    else if ((0, group_1.isUnsavedGroup)(obj)) {
+        return 'group';
+    }
+}
+exports.getEntityType = getEntityType;
+//# sourceMappingURL=reflection.js.map

package/dist/reflection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reflection.js","sourceRoot":"","sources":["../src/reflection.ts"],"names":[],"mappings":";;;AAAA,2CAA4D;AAC5D,2CAA4D;AAC5D,uCAAsD;AACtD,mCAAgD;AAKhD,SAAgB,aAAa,CAAC,GAAQ;IAClC,IAAI,IAAA,8BAAkB,EAAC,GAAG,CAAC,EAAE;QACzB,OAAO,WAAW,CAAC;KACtB;SAAM,IAAI,IAAA,8BAAkB,EAAC,GAAG,CAAC,EAAE;QAChC,OAAO,WAAW,CAAC;KACtB;SAAM,IAAI,IAAA,0BAAgB,EAAC,GAAG,CAAC,EAAE;QAC9B,OAAO,SAAS,CAAC;KACpB;SAAM,IAAI,IAAA,sBAAc,EAAC,GAAG,CAAC,EAAE;QAC5B,OAAO,OAAO,CAAC;KAClB;AACL,CAAC;AAVD,sCAUC"}

package/dist/reporting.d.ts

@@ -0,0 +1,35 @@
+export type TimeWindow = {
+    from: number;
+    to: number;
+};
+export type TimeGranularity = 'fiveMinutes' | 'hour' | 'day' | 'week' | 'month';
+export type UptimeProperties = {
+    startedById?: string;
+    ownerId?: string;
+    projectId?: string;
+    workspaceId?: string;
+};
+export type UptimePropertyName = keyof UptimeProperties;
+export type UptimeQuery = {
+    when: TimeWindow;
+    where: UptimeProperties;
+};
+export type GroupedUptimeQuery = UptimeQuery & {
+    groupBy?: UptimePropertyName;
+};
+export type UptimeTimeSeriesQuery = GroupedUptimeQuery & {
+    granularity?: TimeGranularity;
+};
+export type UptimeRecord = {
+    groupKey: string;
+    groupLabel?: string;
+    minutes: number;
+};
+export type UptimeTimeSeriesEntry = {
+    ts: number;
+    total: number;
+    counts: UptimeRecord[];
+};
+export type UptimeTimeSeries = UptimeTimeSeriesEntry[];
+export declare function getAllGroupKeys(series: UptimeTimeSeries): string[];
+export declare function getAllGroupLabels(series: UptimeTimeSeries): string[];

package/dist/reporting.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllGroupLabels = exports.getAllGroupKeys = void 0;
+function getAllGroupKeys(series) {
+    const groupKeys = new Set();
+    series.forEach((point) => point.counts.forEach((count) => groupKeys.add(count.groupKey)));
+    return Array.from(groupKeys);
+}
+exports.getAllGroupKeys = getAllGroupKeys;
+function getAllGroupLabels(series) {
+    const groupLabels = new Set();
+    series.forEach((point) => point.counts.forEach((count) => groupLabels.add(count.groupLabel || count.groupKey)));
+    return Array.from(groupLabels);
+}
+exports.getAllGroupLabels = getAllGroupLabels;
+//# sourceMappingURL=reporting.js.map

package/dist/reporting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporting.js","sourceRoot":"","sources":["../src/reporting.ts"],"names":[],"mappings":";;;AA2CA,SAAgB,eAAe,CAAC,MAAwB;IACpD,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACrB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CACjE,CAAC;IACF,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC;AAND,0CAMC;AAED,SAAgB,iBAAiB,CAAC,MAAwB;IACtD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CACrB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC3B,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,QAAQ,CAAC,CACtD,CACJ,CAAC;IACF,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACnC,CAAC;AARD,8CAQC"}

package/dist/requests.d.ts

@@ -0,0 +1,22 @@
+import { ApplicationRole } from './rbac';
+export type ListPodsRequest = {
+    namespace?: string;
+    labelSelector?: Record<string, string>;
+    fieldSelector?: Record<string, string>;
+};
+export type UpdateExpirationRequest = {
+    id: string;
+    deadline: number;
+};
+export type AuthRequest = {
+    token: string;
+};
+export type UpdateUserRoleRequest = {
+    userId: string;
+    role: ApplicationRole;
+};
+export type ChangePasswordRequest = {
+    developerId: string;
+    password?: string;
+    mustChangeOnNextLogin: boolean;
+};

package/dist/requests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=requests.js.map

package/dist/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../src/requests.ts"],"names":[],"mappings":""}

package/dist/session.d.ts

@@ -0,0 +1,12 @@
+import { Developer } from './developer';
+import { NavData } from './navData';
+export type ImpersonationResponse = {
+    developer: Developer;
+    navData: NavData;
+    hasPassword: boolean;
+};
+export type SessionInfo = {
+    currentUser: Developer | null;
+    impersonatedFrom: Developer | null;
+    hasPassword: boolean;
+};

package/dist/session.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=session.js.map

package/dist/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../src/session.ts"],"names":[],"mappings":""}