@digo-org/digo-api 1.0.28 → 1.0.30

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digo-org/digo-api",
   "private": false,
-  "version": "1.0.28",
+  "version": "1.0.30",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/digo-asset.ts

@@ -1,12 +1,11 @@
-import { API_MESSAGES }                                  from '@digo-org/digo-api/src/constants';
-import { Instance, ParametersValue, VizAssetDefinition } from '@digo-org/digo-api/src/types';
+import { Instance, GlobalParameters, VizAssetDefinition, API_MESSAGES } from '@digo-org/digo-api';
 
 import { ReactNode } from 'react';
 
 export abstract class DigoAsset {
   protected rootElement:      any = null;
   protected instances:        Instance[] = [];
-  protected globalParameters: ParametersValue = {};
+  protected globalParameters: GlobalParameters = {};
 
   constructor() {
     this.handleMessage = this.handleMessage.bind(this);

package/src/index.ts

@@ -1,5 +1,13 @@
-export * from '@digo-org/digo-api/src/digo-asset';
+export * from '@digo-org/digo-api/src/constants';
 
-export * from '@digo-org/digo-api/src/types';
+export * from '@digo-org/digo-api/src/types-common';
 
-export * from '@digo-org/digo-api/src/constants';
+export * from '@digo-org/digo-api/src/types-misc';
+
+export * from '@digo-org/digo-api/src/types-viz';
+
+export * from '@digo-org/digo-api/src/types-viz-files';
+
+export * from '@digo-org/digo-api/src/types-data';
+
+export * from '@digo-org/digo-api/src/digo-asset';

package/src/types-common.ts

@@ -0,0 +1,64 @@
+export enum ParameterType {
+  NUMBER   = 'NUMBER',
+  BOOLEAN  = 'BOOLEAN',
+  COLOR    = 'COLOR',
+  TEXT     = 'TEXT',
+  GRADIENT = 'GRADIENT',
+}
+
+export const PARAMETER_TYPES: ParameterType[] = Object.values(ParameterType);
+
+export interface Parameter {
+  type:         ParameterType;
+  definition:   ParameterDefinition;
+  isArray?:     boolean;
+  arrayValues?: ParameterValueArray;
+}
+
+export type ParameterDefinition = ParameterNumber | ParameterBoolean | ParameterColor | ParameterText | ParameterGradient;
+
+export interface ParameterNumber {
+  defaultValue: number;
+  min?:         number;
+  max?:         number;
+  icon?:        string;
+  decimals?:    number;
+  step?:        number;
+  units?:       string;
+};
+
+export interface ParameterGradient {
+  defaultValue: GradientStop[];
+};
+
+export interface ParameterText {
+  defaultValue: string;
+  placeholder?: string;
+};
+
+export interface ParameterColor {
+  defaultValue: string;
+};
+
+export interface ParameterBoolean {
+  defaultValue: boolean;
+};
+
+export interface ParameterArray {
+  defaultValue: ParameterValueArray;
+  definition:   ParameterDefinition;
+  labels:       string[];
+};
+
+// VALUE
+
+export type ParameterValue = ParameterValueSingle | ParameterValueArray;
+
+export type ParameterValueSingle = number |  boolean | string | GradientStop[];
+
+export type ParameterValueArray = number[] |  boolean[] | string[] | GradientStop[][];
+
+export interface GradientStop {
+  color:   string; // hex
+  percent: number;
+}

package/src/types-data.ts

@@ -0,0 +1,19 @@
+import { Parameter, ParameterValue } from '@digo-org/digo-api';
+
+export interface DataAssetDefinition {
+  timeArray: string[];
+  variables: Variable[];
+  entities:  Entity[];
+}
+
+export interface Entity {
+  id:                   string;
+  name:                 string;
+  hidden:               boolean;
+  [variableId: string]: ParameterValue;
+}
+
+export interface Variable extends Parameter {
+  id:   string;
+  name: string;
+}

package/src/types-misc.ts

@@ -0,0 +1,14 @@
+import { ParameterDefinition } from '@digo-org/digo-api';
+
+export interface CommonMetadata {
+  name:         string;
+  description?: string;
+  tags?:        string[];
+}
+
+export interface ParameterTypeDefinition {
+  name:         string;
+  description:  string;
+  icon:         string;
+  defaultValue: ParameterDefinition;
+}

package/src/types-viz-files.ts

@@ -0,0 +1,16 @@
+import { Parameter } from '@digo-org/digo-api';
+
+export type VizAssetFiles = Record<string, VizAssetFile>;
+
+export interface VizAssetFile {
+  code:      string;
+  hidden?:   boolean;
+  active?:   boolean;
+  readOnly?: boolean;
+}
+
+export interface VizParameter extends Parameter {
+  id:       string;
+  name:     string;
+  isGlobal: boolean;
+}

package/src/types-viz.ts

@@ -0,0 +1,15 @@
+import { ParameterValueSingle } from '@digo-org/digo-api';
+
+export interface VizAssetDefinition {
+  globalParameters: GlobalParameters;
+  instances:        Instance[];
+}
+
+export interface GlobalParameters {
+  [parameterId: string]: ParameterValueSingle;
+}
+
+export interface Instance {
+  id:                    string;
+  [parameterId: string]: ParameterValueSingle;
+}

package/src/types.ts

@@ -1,107 +0,0 @@
-export interface VizAsset {
-  id:           string;
-  name:         string;
-  description:  string;
-  tags:         string[];
-  definition:   VizAssetDefinition;
-  files:        VizAssetFiles;
-  last_updated: string;
-}
-
-export interface VizAssetDefinition {
-  globalParameters: ParametersValue;
-  instances:        Instance[];
-}
-
-export type VizAssetParameters = VizParameterProperties[];
-
-export interface VizAssetFile {
-  code:      string;
-  hidden?:   boolean;
-  active?:   boolean;
-  readOnly?: boolean;
-}
-
-export type VizAssetFiles = Record<string, VizAssetFile>;
-
-export interface Instance {
-  id:                    string;
-  [parameterId: string]: SingleParameterValue;
-}
-
-export interface ParametersValue {
-  [parameterId: string]: SingleParameterValue;
-}
-
-export interface VizParameterProperties {
-  id:         string;
-  group:      string;
-  isGlobal:   boolean;
-  properties: ParameterProperties;
-}
-
-export enum ParameterType {
-  NUMBER,
-  BOOLEAN,
-  COLOR,
-  TEXT,
-  GRADIENT,
-}
-
-export type ParameterValue = SingleParameterValue | ArrayParameterValue;
-
-export type SingleParameterValue = number |  boolean | string | GradientStop[];
-
-export type ArrayParameterValue = number[] |  boolean[] | string[] | GradientStop[][];
-
-export interface ParameterProperties {
-  name?:        string;
-  type:         ParameterType;
-  definition:   ParameterNumberProperties | ParameterBooleanProperties | ParameterColorProperties | ParameterTextProperties | ParameterGradientProperties;
-  isArray?:     boolean;
-  arrayValues?: ArrayParameterValue;
-}
-
-export interface ParameterNumberProperties {
-  defaultValue: number;
-  min?:         number;
-  max?:         number;
-  icon:         string;
-  decimals?:    number;
-  step?:        number;
-  units?:       string;
-};
-
-export interface ParameterGradientProperties {
-  defaultValue: GradientStop[];
-};
-
-export interface ParameterTextProperties {
-  defaultValue: string;
-  placeholder?: string;
-};
-
-export interface ParameterColorProperties {
-  defaultValue: string;
-};
-
-export interface ParameterBooleanProperties {
-  defaultValue: boolean;
-};
-
-export interface ParameterArrayProperties {
-  defaultValue: ArrayParameterValue;
-  definition:   ParameterNumberProperties | ParameterBooleanProperties | ParameterColorProperties | ParameterTextProperties | ParameterGradientProperties;
-  labels:       string[];
-};
-
-export interface GradientStop {
-  color:   string; // hex
-  percent: number;
-}
-
-export interface ParameterCommonProperties {
-  className?:        string;
-  onValueChange?:    (value: SingleParameterValue, index?: number) => void;
-  onChangeComplete?: () => void;
-}