insomnia/packages/insomnia-app/app/models/environment.js

// @flow
import * as db from '../common/database';
import type {BaseModel} from './index';
import type {Workspace} from './workspace';

export const name = 'Environment';
export const type = 'Environment';
export const prefix = 'env';
export const canDuplicate = true;

type BaseEnvironment = {
  name: string,
  data: Object,
  color: string | null,

  // For sync control
  isPrivate: boolean
};

export type Environment = BaseModel & BaseEnvironment;

export function init () {
  return {
    name: 'New Environment',
    data: {},
    color: null,
    isPrivate: false
  };
}

export function migrate (doc: Environment): Environment {
  return doc;
}

export function create (patch: Object = {}): Promise<Environment> {
  if (!patch.parentId) {
    throw new Error(`New Environment missing \`parentId\`: ${JSON.stringify(patch)}`);
  }

  return db.docCreate(type, patch);
}

export function update (environment: Environment, patch: Object): Promise<Environment> {
  return db.docUpdate(environment, patch);
}

export function findByParentId (parentId: string): Promise<Array<Environment>> {
  return db.find(type, {parentId});
}

export async function getOrCreateForWorkspaceId (workspaceId: string): Promise<Environment> {
  const environments = await db.find(type, {parentId: workspaceId});

  if (!environments.length) {
    return create({
      parentId: workspaceId,
      name: 'Base Environment'
    });
  }

  return environments[environments.length - 1];
}

export async function getOrCreateForWorkspace (workspace: Workspace): Promise<Environment> {
  return getOrCreateForWorkspaceId(workspace._id);
}

export function getById (id: string): Promise<Environment | null> {
  return db.get(type, id);
}

export function remove (environment: Environment): Promise<void> {
  return db.remove(environment);
}

export function all (): Promise<Array<Environment>> {
  return db.all(type);
}