@knapsack/app/src/lib/features.ts

Build Design Systems on top of knapsack, by Basalt

/**
 *  Copyright (C) 2018 Basalt
    This file is part of Knapsack.
    Knapsack is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by the Free
    Software Foundation; either version 2 of the License, or (at your option)
    any later version.

    Knapsack is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
    more details.

    You should have received a copy of the GNU General Public License along
    with Knapsack; if not, see <https://www.gnu.org/licenses>.
 */
import fflip from 'fflip';
import { KsUserInfo } from '@knapsack/core/src/cloud';

export enum FeatureList {
  'templatePush' = 'templatePush',
  /**
   * Used to hide/show UI that does not save/work. Useful for in-progress work.
   */
  'showNonFunctioningUi' = 'showNonFunctioningUi',
  /** Automatically save to local files upon change */
  'autosave' = 'autosave',
  isLocalDev = 'isLocalDev',
}

enum Criteria {
  'isLocalDev' = 'isLocalDev',
  'isKsDev' = 'isKsDev',
  'isKsTestRun' = 'isKsTestRun',
}

export type Features = keyof typeof FeatureList;
export type KsFeatures = Record<Features, boolean>;

const { NODE_ENV, KS_DEV, KS_TEST_RUN } = process.env;

const isProd = NODE_ENV === 'production';

const criteria: {
  id: Criteria;
  check: (user: KsUserInfo, arg: boolean) => boolean;
}[] = [
  {
    id: Criteria.isLocalDev,
    check: (user, arg) => {
      return (arg !== isProd) === arg;
    },
  },
  {
    id: Criteria.isKsDev,
    check: (user, isKsDev) => {
      return (KS_DEV === 'yes') === isKsDev;
    },
  },
  {
    id: Criteria.isKsTestRun,
    check: (user, isKsTestRun) => {
      return (KS_TEST_RUN === 'yes') === isKsTestRun;
    },
  },
];

const featuresConfig: {
  id: keyof typeof FeatureList;
  criteria: Partial<Record<keyof typeof Criteria, boolean>>;
}[] = [
  {
    id: FeatureList.templatePush,
    criteria: {
      isLocalDev: true,
    },
  },
  {
    id: FeatureList.showNonFunctioningUi,
    criteria: {
      isKsDev: true,
    },
  },
  {
    id: FeatureList.autosave,
    criteria: {
      isLocalDev: true,
      isKsTestRun: false,
    },
  },
  {
    id: FeatureList.isLocalDev,
    criteria: {
      isLocalDev: true,
    },
  },
];

fflip.config({
  criteria,
  features: featuresConfig,
});

export function getFeaturesForUser(userInfo: KsUserInfo): KsFeatures {
  return fflip.getFeaturesForUser(userInfo);
}

export const enableBlockquotes = false;
export const enableUiSettings = true;
// @todo fix ability to create new patterns via UI
export const enableUiCreatePattern = false;
export const enableTemplatePush = true;
// @todo enablePatternIcons is not support in pattern-grid.jsx and playground-sidebar--pattern-list-item as of adoption of gql over REST API
export const enablePatternIcons = false;
export const enableCodeBlockLiveEdit = false;