preference-schema.ts

/** ******************************************************************************
 * Copyright (C) 2018 Red Hat, Inc. and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/
// Some code copied and modified from https://github.com/eclipse-theia/theia/tree/v1.14.0/packages/core/src/common/preferences/preference-schema.ts

import { PreferenceScope } from './preference-scope';

export interface PreferenceSchema {
  [name: string]: any;
  scope?: 'application' | 'window' | 'resource' | PreferenceScope;
  overridable?: boolean;
  overrideIdentifier?: string;
  properties: PreferenceSchemaProperties;
}
export namespace PreferenceSchema {
  export function is(obj: any): obj is PreferenceSchema {
    return !!obj && 'properties' in obj && PreferenceSchemaProperties.is(obj['properties']);
  }
  export function getDefaultScope(schema: PreferenceSchema): PreferenceScope {
    let defaultScope: PreferenceScope = PreferenceScope.Workspace;
    if (!PreferenceScope.is(schema.scope)) {
      defaultScope = PreferenceScope.fromString(schema.scope as string) || PreferenceScope.Workspace;
    } else {
      defaultScope = schema.scope;
    }
    return defaultScope;
  }
}

export interface PreferenceSchemaProperties {
  [name: string]: PreferenceSchemaProperty;
}
export namespace PreferenceSchemaProperties {
  export function is(obj: any): obj is PreferenceSchemaProperties {
    return !!obj && typeof obj === 'object';
  }
}

export interface PreferenceDataSchema {
  [name: string]: any;
  scope?: PreferenceScope;
  properties: {
    [name: string]: PreferenceDataProperty;
  };
  patternProperties: {
    [name: string]: PreferenceDataProperty;
  };
}

export interface PreferenceItem {
  type?: PreferencePropertyType | PreferencePropertyType[];
  minimum?: number;
  /**
   * content assist (UI) default value
   */
  default?: any;
  /**
   * preference default value, if `undefined` then `default`
   */
  defaultValue?: any;
  enum?: Array<string | number | boolean>;
  enumDescriptions?: Array<string>;
  items?: PreferenceItem;
  properties?: { [name: string]: PreferenceItem };
  additionalProperties?: object;
  overridable?: boolean;

  description?: string;
  markdownDescription?: string;

  deprecationMessage?: string;
  markdownDeprecationMessage?: string;
  [name: string]: any;
}

export interface PreferenceSchemaProperty extends PreferenceItem {
  description?: string;
  scope?: 'application' | 'window' | 'resource' | PreferenceScope;
}

export interface PreferenceDataProperty extends PreferenceItem {
  description?: string;
  scope?: PreferenceScope;
}
export namespace PreferenceDataProperty {
  export function fromPreferenceSchemaProperty(
    schemaProps: PreferenceSchemaProperty,
    defaultScope: PreferenceScope = PreferenceScope.Workspace,
  ): PreferenceDataProperty {
    if (!schemaProps.scope) {
      schemaProps.scope = defaultScope;
    } else if (typeof schemaProps.scope === 'string') {
      return Object.assign(schemaProps, { scope: PreferenceScope.fromString(schemaProps.scope) || defaultScope });
    }
    return schemaProps as PreferenceDataProperty;
  }
}

export const PREFERENCE_PROPERTY_TYPE = {
  STRING: 'string',
  ARRAY: 'array',
  INT: 'integer',
  NUMBER: 'number',
  OBJECT: 'object',
  BOOLEAN: 'boolean',
  NULL: 'null',
  STRING_ARRAY: 'string[]',
} as const;

export type PreferencePropertyType = typeof PREFERENCE_PROPERTY_TYPE[keyof typeof PREFERENCE_PROPERTY_TYPE];