@ordinlabs/wsm-types 2.2.2 → 2.2.3-alpha.10

package/dist/workspace.d.ts

@@ -1,69 +1,69 @@
-import * as k8s from '@kubernetes/client-node';
-import { VirtualServer } from './nginx-ingress-types';
-import { StoredParamValues } from '@ordinlabs/wsm-common/dist/param-types';
-import { HasHttpAccessRules } from './accessRules';
-import { DataObject, HasKubeStructureVersion, NamedDataObject, UnsavedDataObject } from './base';
-import { GitRepoRefInfo } from './project';
-export type WorkspaceTemplateId = 'm2Ubuntu' | 'm1V2' | 'wordpressV2' | 'drupalV2' | 'laravel' | 'm2' | 'm1' | 'wordpress' | 'drupal';
-export type WorkspaceInfo = NamedDataObject & {
-    projectId: string;
-    developerId: string;
-    lastSeen?: number;
-};
-export type WorkspaceInitType = 'empty' | 'repo' | 'install';
-export type WorkspaceInitOptions = {
-    type: WorkspaceInitType;
-    repo?: string;
-    ref?: GitRepoRefInfo;
-};
-export type Workspace = WorkspaceInfo & HasHttpAccessRules & HasKubeStructureVersion & {
-    volumeSize: number;
-    initOptions?: WorkspaceInitOptions;
-    initialized: boolean;
-    /**
-     * Represents a keypair in PrivateKey/PublicKey collections (shared ID, see crypto.ts).
-     * Used for SSH access into the workspace.
-     */
-    keyPairId?: string;
-    workspaceTemplate: WorkspaceTemplateId;
-    workspaceParams: StoredParamValues<any>;
-};
-export type UnsavedWorkspace = Omit<UnsavedDataObject<Workspace>, 'kubeStructureVersion' | 'initialized' | 'lastSeen'>;
-export type WorkspaceDescription = DataObject & {
-    workspaceId: string;
-    description: string;
-    latest: boolean;
-    createdBy: string;
-};
-export type UpdateWorkspaceDescriptionRequest = {
-    id: string;
-    description: string;
-};
-export type WorkspaceInspection = {
-    workspace: Workspace;
-    resolvedParams: object;
-    deployment: k8s.V1Deployment;
-    currentPod?: k8s.V1Pod;
-    initJob?: k8s.V1Job;
-    pvc?: k8s.V1PersistentVolumeClaim;
-    projectVolumes?: k8s.V1PersistentVolumeClaim[];
-    projectVirtualServers?: VirtualServer[];
-    internalService?: k8s.V1Service;
-    nodePortService?: k8s.V1Service;
-    ebsClaims?: k8s.V1PersistentVolumeClaim[];
-    ingress?: k8s.V1Ingress;
-    virtualServers?: VirtualServer[];
-    events?: k8s.CoreV1Event[];
-    description: WorkspaceDescription | null;
-};
-export type StartWorkspaceRequest = {
-    workspaceId: string;
-    expiration?: number;
-};
-export declare function isStartWorkspaceRequest(obj: any): obj is StartWorkspaceRequest;
-export type WorkspaceInitLog = DataObject & {
-    log: string;
-};
-export declare function isUnsavedWorkspace(obj: any): obj is UnsavedWorkspace;
-export declare function isWorkspace(obj: any): obj is Workspace;
-export declare function isWorkspaceLogRecord(obj: any): obj is WorkspaceInitLog;
+import * as k8s from '@kubernetes/client-node';
+import { VirtualServer } from './nginx-ingress-types';
+import { StoredParamValues } from './params';
+import { HasHttpAccessRules } from './accessRules';
+import { DataObject, HasKubeStructureVersion, NamedDataObject, UnsavedDataObject } from './base';
+import { GitRepoRefInfo } from './project';
+export type WorkspaceTemplateId = 'm2Ubuntu' | 'm1V2' | 'wordpressV2' | 'drupalV2' | 'laravel' | 'm2' | 'm1' | 'wordpress' | 'drupal';
+export type WorkspaceInfo = NamedDataObject & {
+    projectId: string;
+    developerId: string;
+    lastSeen?: number;
+};
+export type WorkspaceInitType = 'empty' | 'repo' | 'install';
+export type WorkspaceInitOptions = {
+    type: WorkspaceInitType;
+    repo?: string;
+    ref?: GitRepoRefInfo;
+};
+export type Workspace = WorkspaceInfo & HasHttpAccessRules & HasKubeStructureVersion & {
+    volumeSize: number;
+    initOptions?: WorkspaceInitOptions;
+    initialized: boolean;
+    /**
+     * Represents a keypair in PrivateKey/PublicKey collections (shared ID, see crypto.ts).
+     * Used for SSH access into the workspace.
+     */
+    keyPairId?: string;
+    workspaceTemplate: WorkspaceTemplateId;
+    workspaceParams: StoredParamValues<any>;
+};
+export type UnsavedWorkspace = Omit<UnsavedDataObject<Workspace>, 'kubeStructureVersion' | 'initialized' | 'lastSeen'>;
+export type WorkspaceDescription = DataObject & {
+    workspaceId: string;
+    description: string;
+    latest: boolean;
+    createdBy: string;
+};
+export type UpdateWorkspaceDescriptionRequest = {
+    id: string;
+    description: string;
+};
+export type WorkspaceInspection = {
+    workspace: Workspace;
+    resolvedParams: object;
+    deployment: k8s.V1Deployment;
+    currentPod?: k8s.V1Pod;
+    initJob?: k8s.V1Job;
+    pvc?: k8s.V1PersistentVolumeClaim;
+    projectVolumes?: k8s.V1PersistentVolumeClaim[];
+    projectVirtualServers?: VirtualServer[];
+    internalService?: k8s.V1Service;
+    nodePortService?: k8s.V1Service;
+    ebsClaims?: k8s.V1PersistentVolumeClaim[];
+    ingress?: k8s.V1Ingress;
+    virtualServers?: VirtualServer[];
+    events?: k8s.CoreV1Event[];
+    description: WorkspaceDescription | null;
+};
+export type StartWorkspaceRequest = {
+    workspaceId: string;
+    expiration?: number;
+};
+export declare function isStartWorkspaceRequest(obj: any): obj is StartWorkspaceRequest;
+export type WorkspaceInitLog = DataObject & {
+    log: string;
+};
+export declare function isUnsavedWorkspace(obj: any): obj is UnsavedWorkspace;
+export declare function isWorkspace(obj: any): obj is Workspace;
+export declare function isWorkspaceLogRecord(obj: any): obj is WorkspaceInitLog;

package/dist/workspace.js

@@ -1,23 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWorkspaceLogRecord = exports.isWorkspace = exports.isUnsavedWorkspace = exports.isStartWorkspaceRequest = void 0;
-const base_1 = require("./base");
-function isStartWorkspaceRequest(obj) {
-    return !!obj && typeof obj.workspaceId === 'string';
-}
-exports.isStartWorkspaceRequest = isStartWorkspaceRequest;
-function isUnsavedWorkspace(obj) {
-    if (!(0, base_1.isUnsavedEntity)(obj))
-        return false;
-    return (typeof obj.developerId === 'string' && typeof obj.projectId === 'string');
-}
-exports.isUnsavedWorkspace = isUnsavedWorkspace;
-function isWorkspace(obj) {
-    return (0, base_1.isEntity)(obj) && isUnsavedWorkspace(obj);
-}
-exports.isWorkspace = isWorkspace;
-function isWorkspaceLogRecord(obj) {
-    return typeof obj.log === 'string' && (0, base_1.isEntity)(obj);
-}
-exports.isWorkspaceLogRecord = isWorkspaceLogRecord;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWorkspaceLogRecord = exports.isWorkspace = exports.isUnsavedWorkspace = exports.isStartWorkspaceRequest = void 0;
+const base_1 = require("./base");
+function isStartWorkspaceRequest(obj) {
+    return !!obj && typeof obj.workspaceId === 'string';
+}
+exports.isStartWorkspaceRequest = isStartWorkspaceRequest;
+function isUnsavedWorkspace(obj) {
+    if (!(0, base_1.isUnsavedEntity)(obj))
+        return false;
+    return (typeof obj.developerId === 'string' && typeof obj.projectId === 'string');
+}
+exports.isUnsavedWorkspace = isUnsavedWorkspace;
+function isWorkspace(obj) {
+    return (0, base_1.isEntity)(obj) && isUnsavedWorkspace(obj);
+}
+exports.isWorkspace = isWorkspace;
+function isWorkspaceLogRecord(obj) {
+    return typeof obj.log === 'string' && (0, base_1.isEntity)(obj);
+}
+exports.isWorkspaceLogRecord = isWorkspaceLogRecord;
 //# sourceMappingURL=workspace.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ordinlabs/wsm-types",
-    "version": "2.2.2",
+    "version": "2.2.3-alpha.10",
     "description": "",
     "main": "dist/index.js",
     "scripts": {
@@ -14,7 +14,7 @@
     },
     "license": "LGPL-3.0-only",
     "devDependencies": {
-        "@ordinlabs/prettier-config-wsm": "^2.2.2",
+        "@ordinlabs/prettier-config-wsm": "^2.2.3-alpha.10",
         "@types/jest": "^27.4.1",
         "@types/jsbn": "^1.2.30",
         "jest": "26.6.0",
@@ -31,9 +31,12 @@
         "moment-timezone": "^0.5.34"
     },
     "prettier": "@ordinlabs/prettier-config-wsm",
-    "gitHead": "fda36ef46bf4d285c80dd7c20d5e350ed09d37a6",
+    "gitHead": "844b189f4f4377aee9a6e4a054ace9013129d22d",
     "publishConfig": {
         "access": "public",
         "registry": "https://registry.npmjs.org/"
-    }
+    },
+    "files": [
+        "dist"
+    ]
 }

package/src/accessRules.ts

@@ -1,18 +0,0 @@
-export type AllowListEntry = {
-    value: string;
-    comment?: string;
-};
-
-export type HttpAccessRule = {
-    id: string;
-    anyIp: boolean;
-    allowedIps?: AllowListEntry[];
-    anyPath: boolean;
-    allowedPaths?: AllowListEntry[];
-    enableCloudEditing?: boolean;
-    comment?: string;
-};
-
-export type HasHttpAccessRules = {
-    httpAccessRules?: HttpAccessRule[];
-};

package/src/apiKey.ts

@@ -1,16 +0,0 @@
-export type APIKeyInfo = {
-    id: string;
-    userId: string;
-    note: string;
-    created: number;
-    expiresAt: number;
-};
-
-export type APIKey = APIKeyInfo & {
-    secret: string;
-};
-
-export type CreateAPIKeyRequest = {
-    note: string;
-    expiresAt: number;
-};

package/src/base.ts

@@ -1,35 +0,0 @@
-export type HasId<K = string> = {
-    id: K;
-};
-
-export type DatedObject = {
-    created: number;
-    lastModified: number;
-};
-
-export type HasKubeStructureVersion = {
-    kubeStructureVersion: number;
-};
-
-export type IdAndName<K = string> = {
-    id: K;
-    name: string;
-};
-
-export type DataObject<K = string> = HasId<K> & DatedObject;
-export type NamedDataObject<K = string> = IdAndName<K> & DatedObject;
-export type UnsavedDataObject<T extends DataObject> = Omit<
-    T,
-    'id' | 'created' | 'lastModified'
->;
-
-export type Optional<Type, Key extends keyof Type> = Omit<Type, Key> &
-    Partial<Pick<Type, Key>>;
-
-export function isEntity(obj: any): obj is DataObject<string> {
-    return typeof obj?.id === 'string' && isUnsavedEntity(obj);
-}
-
-export function isUnsavedEntity(obj: any): obj is UnsavedDataObject<any> {
-    return typeof obj === 'object' && typeof obj?.name === 'string';
-}

package/src/clientConfig.ts

@@ -1,13 +0,0 @@
-export type ClientConfig = {
-    appVersion: string;
-    sshHost: string;
-    sshNamePrefix: string;
-    workspaceDomain: string;
-    projectTemplateDefaults: Record<string, object>;
-    workspaceTemplateDefaults: Record<string, object>;
-    serverIpRanges: string[];
-    defaultTimezone: string;
-    authProviders: string[];
-    approvedGoogleDomains: string[];
-    vpnSupportEnabled: boolean;
-};

package/src/developer.ts

@@ -1,29 +0,0 @@
-import { ApplicationRole } from './rbac';
-import {
-    isEntity,
-    isUnsavedEntity,
-    NamedDataObject,
-    UnsavedDataObject,
-} from './base';
-
-export type DeveloperInfo = NamedDataObject & {
-    email: string;
-    appRole?: ApplicationRole;
-};
-
-export type Developer = DeveloperInfo & {
-    /** @deprecated use `publicKeys` instead */
-    publicKey?: string;
-    publicKeys: string[];
-    timezone?: string;
-};
-
-export type UnsavedDeveloper = UnsavedDataObject<Developer>;
-
-export function isUnsavedDeveloper(obj: any): obj is UnsavedDeveloper {
-    return isUnsavedEntity(obj) && typeof obj.email === 'string';
-}
-
-export function isDeveloper(obj: any): obj is Developer {
-    return isEntity(obj) && isUnsavedDeveloper(obj);
-}

package/src/group.ts

@@ -1,38 +0,0 @@
-import {
-    isEntity,
-    isUnsavedEntity,
-    NamedDataObject,
-    UnsavedDataObject,
-} from './base';
-import { GroupRole } from './rbac';
-import { UserAssociation, UserAssociationId } from './memberships';
-
-export type GroupInfo = NamedDataObject;
-export type MyGroupInfo = GroupInfo & {
-    role?: GroupRole;
-};
-export type Group = GroupInfo;
-export type UnsavedGroup = UnsavedDataObject<Group>;
-
-export function isUnsavedGroup(obj: any): obj is UnsavedGroup {
-    return isUnsavedEntity(obj);
-}
-
-export function isGroup(obj: any): obj is Group {
-    return isEntity(obj) && isUnsavedGroup(obj);
-}
-
-// User memberships
-
-export type UserGroupRoleId = UserAssociationId & {
-    groupId: string;
-};
-export type UserGroupRole = UserAssociation<GroupRole, UserGroupRoleId>;
-
-export function isUserGroupRoleId(obj: any): obj is UserGroupRoleId {
-    return typeof obj?.userId === 'string' && typeof obj?.groupId === 'string';
-}
-
-export function isUserGroupRole(obj: any): obj is UserGroupRole {
-    return isUserGroupRoleId(obj.id) && typeof obj?.role === 'string';
-}

package/src/index.ts

@@ -1,21 +0,0 @@
-export * from './accessRules';
-export * from './apiKey';
-export * from './base';
-export * from './clientConfig';
-export * from './developer';
-export * from './group';
-export * from './login';
-export * from './memberships';
-export * from './navData';
-export * from './network';
-export * from './node';
-export * from './project';
-export * from './publicKey';
-export * from './reflection';
-export * from './reporting';
-export * from './requests';
-export * from './session';
-export * from './workspace';
-export * from './k8s';
-export * from './nginx-ingress-types';
-export * from './rbac';

package/src/k8s.ts

@@ -1,4 +0,0 @@
-export type HasNameAndNamespace = {
-    metadata: { name: string; namespace: string };
-};
-export type HasName = { metadata: { name: string } };

package/src/login.ts

@@ -1,36 +0,0 @@
-import { Developer } from './developer';
-import { NavData } from './navData';
-
-export type PasswordOptions = {
-    mustChange: boolean;
-};
-
-export type PasswordMetadata = PasswordOptions & {
-    failureCount: number;
-    lastChanged: number;
-};
-
-export const BAD_LOGIN_CREDENTIALS = 1;
-export const TOO_MANY_LOGIN_FAILURES = 2;
-export const LOGIN_BLOCKED = 3;
-export type LoginErrorCode =
-    | typeof BAD_LOGIN_CREDENTIALS
-    | typeof TOO_MANY_LOGIN_FAILURES
-    | typeof LOGIN_BLOCKED;
-export type LoginRequest = {
-    username: string;
-    password: string;
-    rememberMe: boolean;
-};
-export type LoginSuccess = {
-    success: true;
-    mustChangePassword: boolean;
-    developer: Developer;
-};
-export type LoginFailure = {
-    success: false;
-    errorCode: LoginErrorCode;
-};
-export type LoginResult = LoginSuccess | LoginFailure;
-export type RPCLoginSuccess = LoginSuccess & { navData: NavData };
-export type RPCLoginResult = RPCLoginSuccess | LoginFailure;

package/src/memberships.ts

@@ -1,12 +0,0 @@
-import { HasId } from './base';
-
-export type UserAssociationId = {
-    userId: string;
-};
-
-export type UserAssociation<
-    T extends string,
-    I extends UserAssociationId
-> = HasId<I> & {
-    role: T;
-};

package/src/navData.ts

@@ -1,16 +0,0 @@
-import { ClientConfig } from './clientConfig';
-import { WorkspaceInfo } from './workspace';
-import { MyProjectInfo } from './project';
-import { DeveloperInfo } from './developer';
-import { MyGroupInfo } from './group';
-import { NodeInfo, RunningPodInfo } from './node';
-
-export type NavData = {
-    config: ClientConfig;
-    workspaces: WorkspaceInfo[];
-    projects: MyProjectInfo[];
-    developers: DeveloperInfo[];
-    groups: MyGroupInfo[];
-    nodes: NodeInfo[];
-    runningPods: RunningPodInfo;
-};

package/src/network.ts

@@ -1,35 +0,0 @@
-import { DataObject, Optional, UnsavedDataObject } from './base';
-
-export type PortMapTypes = 'xdebug' | 'custom';
-
-export type PortMap = {
-    type: PortMapTypes;
-    label: string;
-    from: number;
-    to: number;
-};
-
-export type UnsavedPortMap = Optional<PortMap, 'from'>;
-
-export type WireGuardPeer = DataObject & {
-    label: string;
-    userId: string;
-    publicKey: string;
-    privateKey: string;
-    preSharedKey: string;
-    ipAddress: string;
-    portMaps?: (PortMap | UnsavedPortMap)[];
-};
-
-export type UnsavedWireGuardPeer = Optional<
-    UnsavedDataObject<WireGuardPeer>,
-    'publicKey' | 'privateKey' | 'preSharedKey' | 'ipAddress'
->;
-
-export function isUnsavedWireGuardPeer(obj: any): obj is UnsavedWireGuardPeer {
-    return typeof obj === 'object' && typeof obj?.id === 'undefined';
-}
-
-export function isWireGuardPeer(obj: any): obj is WireGuardPeer {
-    return typeof obj === 'object' && typeof obj?.id === 'string';
-}