@teambit/compositions 0.0.522 → 0.0.526

package/composition.ts

@@ -3,6 +3,7 @@ import { humanizeCompositionId } from '@teambit/compositions.model.composition-i
 export type CompositionProps = {
   identifier: string;
   filepath?: string;
+  displayName?: string;
 };
 
 export class Composition {
@@ -15,23 +16,29 @@ export class Composition {
     /**
      * file path in which the composition is contained.
      */
-    readonly filepath?: string
+    readonly filepath?: string,
+
+    /**
+     * set explicit display name
+     */
+    private _displayName?: string
   ) {}
 
   get displayName() {
-    return humanizeCompositionId(this.identifier);
+    return this._displayName || humanizeCompositionId(this.identifier);
   }
 
   toObject() {
     return {
       identifier: this.identifier,
       filepath: this.filepath,
+      displayName: this._displayName,
     };
   }
 
   static fromArray(compositions: CompositionProps[]): Composition[] {
     return compositions.map((composition) => {
-      return new Composition(composition.identifier, composition.filepath);
+      return new Composition(composition.identifier, composition.filepath, composition.displayName);
     });
   }
 }

package/compositions.graphql.ts

@@ -18,6 +18,7 @@ export function compositionsSchema(compositions: CompositionsMain): Schema {
       type Composition {
         filepath: String
         identifier: String
+        displayName: String
       }
     `,
     resolvers: {

package/compositions.main.runtime.ts

@@ -118,7 +118,13 @@ export class CompositionsMain {
 
     const module = this.schema.parseModule(join(this.workspace.componentDir(component.id), file.relative));
     return module.exports.map((exportModel) => {
-      return new Composition(exportModel.identifier, file.relative);
+      const displayName = exportModel.staticProperties?.get('compositionName');
+
+      return new Composition(
+        exportModel.identifier,
+        file.relative,
+        typeof displayName === 'string' ? displayName : undefined
+      );
     });
   }
 

package/dist/composition.d.ts

@@ -1,15 +1,18 @@
 export declare type CompositionProps = {
     identifier: string;
     filepath?: string;
+    displayName?: string;
 };
 export declare class Composition {
     readonly identifier: string;
     readonly filepath?: string | undefined;
-    constructor(identifier: string, filepath?: string | undefined);
+    private _displayName?;
+    constructor(identifier: string, filepath?: string | undefined, _displayName?: string | undefined);
     get displayName(): string;
     toObject(): {
         identifier: string;
         filepath: string | undefined;
+        displayName: string | undefined;
     };
     static fromArray(compositions: CompositionProps[]): Composition[];
 }

package/dist/composition.js

@@ -24,25 +24,31 @@ class Composition {
   /**
    * file path in which the composition is contained.
    */
-  filepath) {
+  filepath,
+  /**
+   * set explicit display name
+   */
+  _displayName) {
     this.identifier = identifier;
     this.filepath = filepath;
+    this._displayName = _displayName;
   }
 
   get displayName() {
-    return (0, _compositionsModel().humanizeCompositionId)(this.identifier);
+    return this._displayName || (0, _compositionsModel().humanizeCompositionId)(this.identifier);
   }
 
   toObject() {
     return {
       identifier: this.identifier,
-      filepath: this.filepath
+      filepath: this.filepath,
+      displayName: this._displayName
     };
   }
 
   static fromArray(compositions) {
     return compositions.map(composition => {
-      return new Composition(composition.identifier, composition.filepath);
+      return new Composition(composition.identifier, composition.filepath, composition.displayName);
     });
   }
 

package/dist/composition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["composition.ts"],"names":["Composition","constructor","identifier","filepath","displayName","toObject","fromArray","compositions","map","composition"],"mappings":";;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAOO,MAAMA,WAAN,CAAkB;AACvBC,EAAAA,WAAW;AACT;AACJ;AACA;AACaC,EAAAA,UAJA;AAMT;AACJ;AACA;AACaC,EAAAA,QATA,EAUT;AAAA,SANSD,UAMT,GANSA,UAMT;AAAA,SADSC,QACT,GADSA,QACT;AAAE;;AAEW,MAAXC,WAAW,GAAG;AAChB,WAAO,gDAAsB,KAAKF,UAA3B,CAAP;AACD;;AAEDG,EAAAA,QAAQ,GAAG;AACT,WAAO;AACLH,MAAAA,UAAU,EAAE,KAAKA,UADZ;AAELC,MAAAA,QAAQ,EAAE,KAAKA;AAFV,KAAP;AAID;;AAEe,SAATG,SAAS,CAACC,YAAD,EAAkD;AAChE,WAAOA,YAAY,CAACC,GAAb,CAAkBC,WAAD,IAAiB;AACvC,aAAO,IAAIT,WAAJ,CAAgBS,WAAW,CAACP,UAA5B,EAAwCO,WAAW,CAACN,QAApD,CAAP;AACD,KAFM,CAAP;AAGD;;AA5BsB","sourcesContent":["import { humanizeCompositionId } from '@teambit/compositions.model.composition-id';\n\nexport type CompositionProps = {\n  identifier: string;\n  filepath?: string;\n};\n\nexport class Composition {\n  constructor(\n    /**\n     * identifier of the composition\n     */\n    readonly identifier: string,\n\n    /**\n     * file path in which the composition is contained.\n     */\n    readonly filepath?: string\n  ) {}\n\n  get displayName() {\n    return humanizeCompositionId(this.identifier);\n  }\n\n  toObject() {\n    return {\n      identifier: this.identifier,\n      filepath: this.filepath,\n    };\n  }\n\n  static fromArray(compositions: CompositionProps[]): Composition[] {\n    return compositions.map((composition) => {\n      return new Composition(composition.identifier, composition.filepath);\n    });\n  }\n}\n"]}
+{"version":3,"sources":["composition.ts"],"names":["Composition","constructor","identifier","filepath","_displayName","displayName","toObject","fromArray","compositions","map","composition"],"mappings":";;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAQO,MAAMA,WAAN,CAAkB;AACvBC,EAAAA,WAAW;AACT;AACJ;AACA;AACaC,EAAAA,UAJA;AAMT;AACJ;AACA;AACaC,EAAAA,QATA;AAWT;AACJ;AACA;AACYC,EAAAA,YAdC,EAeT;AAAA,SAXSF,UAWT,GAXSA,UAWT;AAAA,SANSC,QAMT,GANSA,QAMT;AAAA,SADQC,YACR,GADQA,YACR;AAAE;;AAEW,MAAXC,WAAW,GAAG;AAChB,WAAO,KAAKD,YAAL,IAAqB,gDAAsB,KAAKF,UAA3B,CAA5B;AACD;;AAEDI,EAAAA,QAAQ,GAAG;AACT,WAAO;AACLJ,MAAAA,UAAU,EAAE,KAAKA,UADZ;AAELC,MAAAA,QAAQ,EAAE,KAAKA,QAFV;AAGLE,MAAAA,WAAW,EAAE,KAAKD;AAHb,KAAP;AAKD;;AAEe,SAATG,SAAS,CAACC,YAAD,EAAkD;AAChE,WAAOA,YAAY,CAACC,GAAb,CAAkBC,WAAD,IAAiB;AACvC,aAAO,IAAIV,WAAJ,CAAgBU,WAAW,CAACR,UAA5B,EAAwCQ,WAAW,CAACP,QAApD,EAA8DO,WAAW,CAACL,WAA1E,CAAP;AACD,KAFM,CAAP;AAGD;;AAlCsB","sourcesContent":["import { humanizeCompositionId } from '@teambit/compositions.model.composition-id';\n\nexport type CompositionProps = {\n  identifier: string;\n  filepath?: string;\n  displayName?: string;\n};\n\nexport class Composition {\n  constructor(\n    /**\n     * identifier of the composition\n     */\n    readonly identifier: string,\n\n    /**\n     * file path in which the composition is contained.\n     */\n    readonly filepath?: string,\n\n    /**\n     * set explicit display name\n     */\n    private _displayName?: string\n  ) {}\n\n  get displayName() {\n    return this._displayName || humanizeCompositionId(this.identifier);\n  }\n\n  toObject() {\n    return {\n      identifier: this.identifier,\n      filepath: this.filepath,\n      displayName: this._displayName,\n    };\n  }\n\n  static fromArray(compositions: CompositionProps[]): Composition[] {\n    return compositions.map((composition) => {\n      return new Composition(composition.identifier, composition.filepath, composition.displayName);\n    });\n  }\n}\n"]}

package/dist/compositions.graphql.js

@@ -31,6 +31,7 @@ function compositionsSchema(compositions) {
       type Composition {
         filepath: String
         identifier: String
+        displayName: String
       }
     `,
     resolvers: {

package/dist/compositions.graphql.js.map

@@ -1 +1 @@
-{"version":3,"sources":["compositions.graphql.ts"],"names":["compositionsSchema","compositions","typeDefs","resolvers","Component","component","getCompositions"],"mappings":";;;;;;;;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAIO,SAASA,kBAAT,CAA4BC,YAA5B,EAAoE;AACzE,SAAO;AACLC,IAAAA,QAAQ,EAAE,0BAAI;AAClB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAdS;AAeLC,IAAAA,SAAS,EAAE;AACTC,MAAAA,SAAS,EAAE;AACTH,QAAAA,YAAY,EAAGI,SAAD,IAA0B;AACtC,iBAAOJ,YAAY,CAACK,eAAb,CAA6BD,SAA7B,CAAP;AACD;AAHQ;AADF;AAfN,GAAP;AAuBD","sourcesContent":["import { Component } from '@teambit/component';\nimport { Schema } from '@teambit/graphql';\nimport gql from 'graphql-tag';\n\nimport { CompositionsMain } from './compositions.main.runtime';\n\nexport function compositionsSchema(compositions: CompositionsMain): Schema {\n  return {\n    typeDefs: gql`\n      extend type Component {\n        compositions: [Composition]\n      }\n\n      type Subscription {\n        compositionAdded: Composition\n      }\n\n      type Composition {\n        filepath: String\n        identifier: String\n      }\n    `,\n    resolvers: {\n      Component: {\n        compositions: (component: Component) => {\n          return compositions.getCompositions(component);\n        },\n      },\n    },\n  };\n}\n"]}
+{"version":3,"sources":["compositions.graphql.ts"],"names":["compositionsSchema","compositions","typeDefs","resolvers","Component","component","getCompositions"],"mappings":";;;;;;;;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAIO,SAASA,kBAAT,CAA4BC,YAA5B,EAAoE;AACzE,SAAO;AACLC,IAAAA,QAAQ,EAAE,0BAAI;AAClB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAfS;AAgBLC,IAAAA,SAAS,EAAE;AACTC,MAAAA,SAAS,EAAE;AACTH,QAAAA,YAAY,EAAGI,SAAD,IAA0B;AACtC,iBAAOJ,YAAY,CAACK,eAAb,CAA6BD,SAA7B,CAAP;AACD;AAHQ;AADF;AAhBN,GAAP;AAwBD","sourcesContent":["import { Component } from '@teambit/component';\nimport { Schema } from '@teambit/graphql';\nimport gql from 'graphql-tag';\n\nimport { CompositionsMain } from './compositions.main.runtime';\n\nexport function compositionsSchema(compositions: CompositionsMain): Schema {\n  return {\n    typeDefs: gql`\n      extend type Component {\n        compositions: [Composition]\n      }\n\n      type Subscription {\n        compositionAdded: Composition\n      }\n\n      type Composition {\n        filepath: String\n        identifier: String\n        displayName: String\n      }\n    `,\n    resolvers: {\n      Component: {\n        compositions: (component: Component) => {\n          return compositions.getCompositions(component);\n        },\n      },\n    },\n  };\n}\n"]}

package/dist/compositions.main.runtime.js

@@ -239,7 +239,10 @@ class CompositionsMain {
     pathArray[pathArray.length - 1] = 'js';
     const module = this.schema.parseModule((0, _path().join)(this.workspace.componentDir(component.id), file.relative));
     return module.exports.map(exportModel => {
-      return new (_composition().Composition)(exportModel.identifier, file.relative);
+      var _exportModel$staticPr;
+
+      const displayName = (_exportModel$staticPr = exportModel.staticProperties) === null || _exportModel$staticPr === void 0 ? void 0 : _exportModel$staticPr.get('compositionName');
+      return new (_composition().Composition)(exportModel.identifier, file.relative, typeof displayName === 'string' ? displayName : undefined);
     });
   }
 

package/dist/compositions.main.runtime.js.map

@@ -1 +1 @@
-{"version":3,"sources":["compositions.main.runtime.ts"],"names":["CompositionsMain","constructor","compositionFilePattern","previewFilePattern","preview","workspace","schema","devFiles","getPreviewFiles","components","ComponentMap","as","component","compositionFiles","state","filesystem","byGlob","previewFiles","Set","map","file","relative","files","filter","has","getCompositions","entry","aspects","get","CompositionsAspect","id","compositions","data","Composition","fromArray","readCompositions","maybeFiles","byComponent","computeCompositions","onComponentLoad","composition","toObject","pathArray","path","split","length","module","parseModule","componentDir","exports","exportModel","identifier","provider","graphql","config","compositionPreviewFilePattern","registerDevPattern","register","registerDefinition","CompositionPreviewDefinition","bind","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","SchemaAspect","DevFilesAspect","ComponentAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAeA;AACA;AACA;AACO,MAAMA,gBAAN,CAAuB;AAC5BC,EAAAA,WAAW;AACT;AACJ;AACA;AACYC,EAAAA,sBAJC;AAMT;AACJ;AACA;AACYC,EAAAA,kBATC;AAWT;AACJ;AACA;AACYC,EAAAA,OAdC;AAgBT;AACJ;AACA;AACYC,EAAAA,SAnBC;AAqBT;AACJ;AACA;AACYC,EAAAA,MAxBC,EA0BDC,QA1BC,EA2BT;AAAA,SAvBQL,sBAuBR,GAvBQA,sBAuBR;AAAA,SAlBQC,kBAkBR,GAlBQA,kBAkBR;AAAA,SAbQC,OAaR,GAbQA,OAaR;AAAA,SARQC,SAQR,GARQA,SAQR;AAAA,SAHQC,MAGR,GAHQA,MAGR;AAAA,SADQC,QACR,GADQA,QACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,eAAe,CAACC,UAAD,EAAyD;AACtE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE;AACA,YAAMC,gBAAgB,GAAGD,SAAS,CAACE,KAAV,CAAgBC,UAAhB,CAA2BC,MAA3B,CAAkC,KAAKd,sBAAvC,CAAzB,CAFiE,CAIjE;;AACA,YAAMe,YAAY,GAAG,IAAIC,GAAJ,CACnBN,SAAS,CAACE,KAAV,CAAgBC,UAAhB,CAA2BC,MAA3B,CAAkC,KAAKb,kBAAvC,EAA2DgB,GAA3D,CAAgEC,IAAD,IAAUA,IAAI,CAACC,QAA9E,CADmB,CAArB;AAGA,YAAMC,KAAK,GAAGT,gBAAgB,CAACU,MAAjB,CAAyBH,IAAD,IAAUH,YAAY,CAACO,GAAb,CAAiBJ,IAAI,CAACC,QAAtB,CAAlC,CAAd;AAEA,aAAOC,KAAP;AACD,KAXM,CAAP;AAYD;AAED;AACF;AACA;;;AACEG,EAAAA,eAAe,CAACb,SAAD,EAAsC;AACnD,UAAMc,KAAK,GAAGd,SAAS,CAACE,KAAV,CAAgBa,OAAhB,CAAwBC,GAAxB,CAA4BC,mCAAmBC,EAA/C,CAAd;AACA,QAAI,CAACJ,KAAL,EAAY,OAAO,EAAP;AACZ,UAAMK,YAAY,GAAGL,KAAK,CAACM,IAAN,CAAWD,YAAhC;AACA,QAAI,CAACA,YAAL,EAAmB,OAAO,EAAP;AAEnB,WAAOE,2BAAYC,SAAZ,CAAsBH,YAAtB,CAAP;AACD;AAED;AACF;AACA;;;AACEI,EAAAA,gBAAgB,CAACvB,SAAD,EAAsC;AACpD,UAAMwB,UAAU,GAAG,KAAK5B,eAAL,CAAqB,CAACI,SAAD,CAArB,EAAkCyB,WAAlC,CAA8CzB,SAA9C,CAAnB;AAEA,QAAI,CAACwB,UAAL,EAAiB,OAAO,EAAP;AACjB,UAAM,GAAGd,KAAH,IAAYc,UAAlB;AACA,WAAO,sBACLd,KAAK,CAACH,GAAN,CAAWC,IAAD,IAAU;AAClB,aAAO,KAAKkB,mBAAL,CAAyB1B,SAAzB,EAAoCQ,IAApC,CAAP;AACD,KAFD,CADK,CAAP;AAKD;;AAEoB,QAAfmB,eAAe,CAAC3B,SAAD,EAA4C;AAC/D,UAAMmB,YAAY,GAAG,KAAKI,gBAAL,CAAsBvB,SAAtB,CAArB;AACA,WAAO;AACLmB,MAAAA,YAAY,EAAEA,YAAY,CAACZ,GAAb,CAAkBqB,WAAD,IAAiBA,WAAW,CAACC,QAAZ,EAAlC;AADT,KAAP;AAGD;;AAEOH,EAAAA,mBAAmB,CAAC1B,SAAD,EAAuBQ,IAAvB,EAA2D;AACpF;AACA,UAAMsB,SAAS,GAAGtB,IAAI,CAACuB,IAAL,CAAUC,KAAV,CAAgB,GAAhB,CAAlB;AACAF,IAAAA,SAAS,CAACA,SAAS,CAACG,MAAV,GAAmB,CAApB,CAAT,GAAkC,IAAlC;AAEA,UAAMC,MAAM,GAAG,KAAKxC,MAAL,CAAYyC,WAAZ,CAAwB,kBAAK,KAAK1C,SAAL,CAAe2C,YAAf,CAA4BpC,SAAS,CAACkB,EAAtC,CAAL,EAAgDV,IAAI,CAACC,QAArD,CAAxB,CAAf;AACA,WAAOyB,MAAM,CAACG,OAAP,CAAe9B,GAAf,CAAoB+B,WAAD,IAAiB;AACzC,aAAO,KAAIjB,0BAAJ,EAAgBiB,WAAW,CAACC,UAA5B,EAAwC/B,IAAI,CAACC,QAA7C,CAAP;AACD,KAFM,CAAP;AAGD;;AAUoB,eAAR+B,QAAQ,CACnB,CAAChD,OAAD,EAAUiD,OAAV,EAAmBhD,SAAnB,EAA8BC,MAA9B,EAAsCC,QAAtC,CADmB,EAEnB+C,MAFmB,EAGnB;AACA,UAAMvB,YAAY,GAAG,IAAI/B,gBAAJ,CACnBsD,MAAM,CAACpD,sBADY,EAEnBoD,MAAM,CAACC,6BAFY,EAGnBnD,OAHmB,EAInBC,SAJmB,EAKnBC,MALmB,EAMnBC,QANmB,CAArB;AAQAA,IAAAA,QAAQ,CAACiD,kBAAT,CAA4BF,MAAM,CAACpD,sBAAnC;AAEAmD,IAAAA,OAAO,CAACI,QAAR,CAAiB,yCAAmB1B,YAAnB,CAAjB;AACA3B,IAAAA,OAAO,CAACsD,kBAAR,CAA2B,KAAIC,6CAAJ,EAAiC5B,YAAjC,CAA3B;;AAEA,QAAI1B,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAACkC,eAAV,CAA0BR,YAAY,CAACQ,eAAb,CAA6BqB,IAA7B,CAAkC7B,YAAlC,CAA1B;AACD;;AAED,WAAOA,YAAP;AACD;;AA3H2B;;;gCAAjB/B,gB,mBA6FgC;AACzCE,EAAAA,sBAAsB,EAAE,CAAC,wBAAD,CADiB;AAEzCqD,EAAAA,6BAA6B,EAAE,CAAC,iBAAD;AAFU,C;gCA7FhCvD,gB,aAkGM6D,kB;gCAlGN7D,gB,kBAmGW,CAAC8D,wBAAD,EAAgBC,wBAAhB,EAA+BC,4BAA/B,EAAgDC,sBAAhD,EAA8DC,0BAA9D,EAA8EC,4BAA9E,C;;AA2BxBtC,mCAAmBuC,UAAnB,CAA8BpE,gBAA9B","sourcesContent":["import { join } from 'path';\nimport { MainRuntime } from '@teambit/cli';\nimport { Component, ComponentAspect, ComponentMap, AspectData } from '@teambit/component';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport { SchemaAspect, SchemaMain } from '@teambit/schema';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport { flatten } from '@teambit/legacy/dist/utils';\nimport { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';\nimport { Composition } from './composition';\nimport { CompositionsAspect } from './compositions.aspect';\nimport { compositionsSchema } from './compositions.graphql';\nimport { CompositionPreviewDefinition } from './compositions.preview-definition';\n\nexport type CompositionsConfig = {\n  /**\n   * glob pattern to detect composition files. This includes all related files, like styles and jsons.\n   * @example ['/*.composition?(s).*']\n   */\n  compositionFilePattern: string[];\n  /**\n   * glob pattern to select Preview files. this will only include files matched by compositionFilePattern.\n   * @example ['*.{t,j}s', '*.{t,j}sx']\n   */\n  compositionPreviewFilePattern: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class CompositionsMain {\n  constructor(\n    /**\n     * Glob pattern to select all composition files\n     */\n    private compositionFilePattern: string[],\n\n    /**\n     * Glob pattern to select composition preview files\n     */\n    private previewFilePattern: string[],\n\n    /**\n     * envs extension.\n     */\n    private preview: PreviewMain,\n\n    /**\n     * workspace extension.\n     */\n    private workspace: Workspace,\n\n    /**\n     * schema extension.\n     */\n    private schema: SchemaMain,\n\n    private devFiles: DevFilesMain\n  ) {}\n\n  /**\n   * returns an array of doc file paths for a set of components.\n   */\n  getPreviewFiles(components: Component[]): ComponentMap<AbstractVinyl[]> {\n    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n      // this includes non executables, like `button.compositions.module.scss` or `presets.compositions.json`\n      const compositionFiles = component.state.filesystem.byGlob(this.compositionFilePattern);\n\n      // select only relevant preview files (.tsx, etc)\n      const previewFiles = new Set(\n        component.state.filesystem.byGlob(this.previewFilePattern).map((file) => file.relative)\n      );\n      const files = compositionFiles.filter((file) => previewFiles.has(file.relative));\n\n      return files;\n    });\n  }\n\n  /**\n   * get component compositions.\n   */\n  getCompositions(component: Component): Composition[] {\n    const entry = component.state.aspects.get(CompositionsAspect.id);\n    if (!entry) return [];\n    const compositions = entry.data.compositions;\n    if (!compositions) return [];\n\n    return Composition.fromArray(compositions);\n  }\n\n  /**\n   * read composition from the component source code.\n   */\n  readCompositions(component: Component): Composition[] {\n    const maybeFiles = this.getPreviewFiles([component]).byComponent(component);\n\n    if (!maybeFiles) return [];\n    const [, files] = maybeFiles;\n    return flatten(\n      files.map((file) => {\n        return this.computeCompositions(component, file);\n      })\n    );\n  }\n\n  async onComponentLoad(component: Component): Promise<AspectData> {\n    const compositions = this.readCompositions(component);\n    return {\n      compositions: compositions.map((composition) => composition.toObject()),\n    };\n  }\n\n  private computeCompositions(component: Component, file: AbstractVinyl): Composition[] {\n    // :TODO hacked for a specific file extension now until david will take care in the compiler.\n    const pathArray = file.path.split('.');\n    pathArray[pathArray.length - 1] = 'js';\n\n    const module = this.schema.parseModule(join(this.workspace.componentDir(component.id), file.relative));\n    return module.exports.map((exportModel) => {\n      return new Composition(exportModel.identifier, file.relative);\n    });\n  }\n\n  static defaultConfig: CompositionsConfig = {\n    compositionFilePattern: ['**/*.composition?(s).*'],\n    compositionPreviewFilePattern: ['**/*.{t,j}s?(x)'],\n  };\n\n  static runtime = MainRuntime;\n  static dependencies = [PreviewAspect, GraphqlAspect, WorkspaceAspect, SchemaAspect, DevFilesAspect, ComponentAspect];\n\n  static async provider(\n    [preview, graphql, workspace, schema, devFiles]: [PreviewMain, GraphqlMain, Workspace, SchemaMain, DevFilesMain],\n    config: CompositionsConfig\n  ) {\n    const compositions = new CompositionsMain(\n      config.compositionFilePattern,\n      config.compositionPreviewFilePattern,\n      preview,\n      workspace,\n      schema,\n      devFiles\n    );\n    devFiles.registerDevPattern(config.compositionFilePattern);\n\n    graphql.register(compositionsSchema(compositions));\n    preview.registerDefinition(new CompositionPreviewDefinition(compositions));\n\n    if (workspace) {\n      workspace.onComponentLoad(compositions.onComponentLoad.bind(compositions));\n    }\n\n    return compositions;\n  }\n}\n\nCompositionsAspect.addRuntime(CompositionsMain);\n"]}
+{"version":3,"sources":["compositions.main.runtime.ts"],"names":["CompositionsMain","constructor","compositionFilePattern","previewFilePattern","preview","workspace","schema","devFiles","getPreviewFiles","components","ComponentMap","as","component","compositionFiles","state","filesystem","byGlob","previewFiles","Set","map","file","relative","files","filter","has","getCompositions","entry","aspects","get","CompositionsAspect","id","compositions","data","Composition","fromArray","readCompositions","maybeFiles","byComponent","computeCompositions","onComponentLoad","composition","toObject","pathArray","path","split","length","module","parseModule","componentDir","exports","exportModel","displayName","staticProperties","identifier","undefined","provider","graphql","config","compositionPreviewFilePattern","registerDevPattern","register","registerDefinition","CompositionPreviewDefinition","bind","MainRuntime","PreviewAspect","GraphqlAspect","WorkspaceAspect","SchemaAspect","DevFilesAspect","ComponentAspect","addRuntime"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAEA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AACA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAeA;AACA;AACA;AACO,MAAMA,gBAAN,CAAuB;AAC5BC,EAAAA,WAAW;AACT;AACJ;AACA;AACYC,EAAAA,sBAJC;AAMT;AACJ;AACA;AACYC,EAAAA,kBATC;AAWT;AACJ;AACA;AACYC,EAAAA,OAdC;AAgBT;AACJ;AACA;AACYC,EAAAA,SAnBC;AAqBT;AACJ;AACA;AACYC,EAAAA,MAxBC,EA0BDC,QA1BC,EA2BT;AAAA,SAvBQL,sBAuBR,GAvBQA,sBAuBR;AAAA,SAlBQC,kBAkBR,GAlBQA,kBAkBR;AAAA,SAbQC,OAaR,GAbQA,OAaR;AAAA,SARQC,SAQR,GARQA,SAQR;AAAA,SAHQC,MAGR,GAHQA,MAGR;AAAA,SADQC,QACR,GADQA,QACR;AAAE;AAEJ;AACF;AACA;;;AACEC,EAAAA,eAAe,CAACC,UAAD,EAAyD;AACtE,WAAOC,0BAAaC,EAAb,CAAiCF,UAAjC,EAA8CG,SAAD,IAAe;AACjE;AACA,YAAMC,gBAAgB,GAAGD,SAAS,CAACE,KAAV,CAAgBC,UAAhB,CAA2BC,MAA3B,CAAkC,KAAKd,sBAAvC,CAAzB,CAFiE,CAIjE;;AACA,YAAMe,YAAY,GAAG,IAAIC,GAAJ,CACnBN,SAAS,CAACE,KAAV,CAAgBC,UAAhB,CAA2BC,MAA3B,CAAkC,KAAKb,kBAAvC,EAA2DgB,GAA3D,CAAgEC,IAAD,IAAUA,IAAI,CAACC,QAA9E,CADmB,CAArB;AAGA,YAAMC,KAAK,GAAGT,gBAAgB,CAACU,MAAjB,CAAyBH,IAAD,IAAUH,YAAY,CAACO,GAAb,CAAiBJ,IAAI,CAACC,QAAtB,CAAlC,CAAd;AAEA,aAAOC,KAAP;AACD,KAXM,CAAP;AAYD;AAED;AACF;AACA;;;AACEG,EAAAA,eAAe,CAACb,SAAD,EAAsC;AACnD,UAAMc,KAAK,GAAGd,SAAS,CAACE,KAAV,CAAgBa,OAAhB,CAAwBC,GAAxB,CAA4BC,mCAAmBC,EAA/C,CAAd;AACA,QAAI,CAACJ,KAAL,EAAY,OAAO,EAAP;AACZ,UAAMK,YAAY,GAAGL,KAAK,CAACM,IAAN,CAAWD,YAAhC;AACA,QAAI,CAACA,YAAL,EAAmB,OAAO,EAAP;AAEnB,WAAOE,2BAAYC,SAAZ,CAAsBH,YAAtB,CAAP;AACD;AAED;AACF;AACA;;;AACEI,EAAAA,gBAAgB,CAACvB,SAAD,EAAsC;AACpD,UAAMwB,UAAU,GAAG,KAAK5B,eAAL,CAAqB,CAACI,SAAD,CAArB,EAAkCyB,WAAlC,CAA8CzB,SAA9C,CAAnB;AAEA,QAAI,CAACwB,UAAL,EAAiB,OAAO,EAAP;AACjB,UAAM,GAAGd,KAAH,IAAYc,UAAlB;AACA,WAAO,sBACLd,KAAK,CAACH,GAAN,CAAWC,IAAD,IAAU;AAClB,aAAO,KAAKkB,mBAAL,CAAyB1B,SAAzB,EAAoCQ,IAApC,CAAP;AACD,KAFD,CADK,CAAP;AAKD;;AAEoB,QAAfmB,eAAe,CAAC3B,SAAD,EAA4C;AAC/D,UAAMmB,YAAY,GAAG,KAAKI,gBAAL,CAAsBvB,SAAtB,CAArB;AACA,WAAO;AACLmB,MAAAA,YAAY,EAAEA,YAAY,CAACZ,GAAb,CAAkBqB,WAAD,IAAiBA,WAAW,CAACC,QAAZ,EAAlC;AADT,KAAP;AAGD;;AAEOH,EAAAA,mBAAmB,CAAC1B,SAAD,EAAuBQ,IAAvB,EAA2D;AACpF;AACA,UAAMsB,SAAS,GAAGtB,IAAI,CAACuB,IAAL,CAAUC,KAAV,CAAgB,GAAhB,CAAlB;AACAF,IAAAA,SAAS,CAACA,SAAS,CAACG,MAAV,GAAmB,CAApB,CAAT,GAAkC,IAAlC;AAEA,UAAMC,MAAM,GAAG,KAAKxC,MAAL,CAAYyC,WAAZ,CAAwB,kBAAK,KAAK1C,SAAL,CAAe2C,YAAf,CAA4BpC,SAAS,CAACkB,EAAtC,CAAL,EAAgDV,IAAI,CAACC,QAArD,CAAxB,CAAf;AACA,WAAOyB,MAAM,CAACG,OAAP,CAAe9B,GAAf,CAAoB+B,WAAD,IAAiB;AAAA;;AACzC,YAAMC,WAAW,4BAAGD,WAAW,CAACE,gBAAf,0DAAG,sBAA8BxB,GAA9B,CAAkC,iBAAlC,CAApB;AAEA,aAAO,KAAIK,0BAAJ,EACLiB,WAAW,CAACG,UADP,EAELjC,IAAI,CAACC,QAFA,EAGL,OAAO8B,WAAP,KAAuB,QAAvB,GAAkCA,WAAlC,GAAgDG,SAH3C,CAAP;AAKD,KARM,CAAP;AASD;;AAUoB,eAARC,QAAQ,CACnB,CAACnD,OAAD,EAAUoD,OAAV,EAAmBnD,SAAnB,EAA8BC,MAA9B,EAAsCC,QAAtC,CADmB,EAEnBkD,MAFmB,EAGnB;AACA,UAAM1B,YAAY,GAAG,IAAI/B,gBAAJ,CACnByD,MAAM,CAACvD,sBADY,EAEnBuD,MAAM,CAACC,6BAFY,EAGnBtD,OAHmB,EAInBC,SAJmB,EAKnBC,MALmB,EAMnBC,QANmB,CAArB;AAQAA,IAAAA,QAAQ,CAACoD,kBAAT,CAA4BF,MAAM,CAACvD,sBAAnC;AAEAsD,IAAAA,OAAO,CAACI,QAAR,CAAiB,yCAAmB7B,YAAnB,CAAjB;AACA3B,IAAAA,OAAO,CAACyD,kBAAR,CAA2B,KAAIC,6CAAJ,EAAiC/B,YAAjC,CAA3B;;AAEA,QAAI1B,SAAJ,EAAe;AACbA,MAAAA,SAAS,CAACkC,eAAV,CAA0BR,YAAY,CAACQ,eAAb,CAA6BwB,IAA7B,CAAkChC,YAAlC,CAA1B;AACD;;AAED,WAAOA,YAAP;AACD;;AAjI2B;;;gCAAjB/B,gB,mBAmGgC;AACzCE,EAAAA,sBAAsB,EAAE,CAAC,wBAAD,CADiB;AAEzCwD,EAAAA,6BAA6B,EAAE,CAAC,iBAAD;AAFU,C;gCAnGhC1D,gB,aAwGMgE,kB;gCAxGNhE,gB,kBAyGW,CAACiE,wBAAD,EAAgBC,wBAAhB,EAA+BC,4BAA/B,EAAgDC,sBAAhD,EAA8DC,0BAA9D,EAA8EC,4BAA9E,C;;AA2BxBzC,mCAAmB0C,UAAnB,CAA8BvE,gBAA9B","sourcesContent":["import { join } from 'path';\nimport { MainRuntime } from '@teambit/cli';\nimport { Component, ComponentAspect, ComponentMap, AspectData } from '@teambit/component';\nimport { GraphqlAspect, GraphqlMain } from '@teambit/graphql';\nimport { PreviewAspect, PreviewMain } from '@teambit/preview';\nimport { SchemaAspect, SchemaMain } from '@teambit/schema';\nimport { Workspace, WorkspaceAspect } from '@teambit/workspace';\nimport { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';\nimport { flatten } from '@teambit/legacy/dist/utils';\nimport { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';\nimport { Composition } from './composition';\nimport { CompositionsAspect } from './compositions.aspect';\nimport { compositionsSchema } from './compositions.graphql';\nimport { CompositionPreviewDefinition } from './compositions.preview-definition';\n\nexport type CompositionsConfig = {\n  /**\n   * glob pattern to detect composition files. This includes all related files, like styles and jsons.\n   * @example ['/*.composition?(s).*']\n   */\n  compositionFilePattern: string[];\n  /**\n   * glob pattern to select Preview files. this will only include files matched by compositionFilePattern.\n   * @example ['*.{t,j}s', '*.{t,j}sx']\n   */\n  compositionPreviewFilePattern: string[];\n};\n\n/**\n * the component documentation extension.\n */\nexport class CompositionsMain {\n  constructor(\n    /**\n     * Glob pattern to select all composition files\n     */\n    private compositionFilePattern: string[],\n\n    /**\n     * Glob pattern to select composition preview files\n     */\n    private previewFilePattern: string[],\n\n    /**\n     * envs extension.\n     */\n    private preview: PreviewMain,\n\n    /**\n     * workspace extension.\n     */\n    private workspace: Workspace,\n\n    /**\n     * schema extension.\n     */\n    private schema: SchemaMain,\n\n    private devFiles: DevFilesMain\n  ) {}\n\n  /**\n   * returns an array of doc file paths for a set of components.\n   */\n  getPreviewFiles(components: Component[]): ComponentMap<AbstractVinyl[]> {\n    return ComponentMap.as<AbstractVinyl[]>(components, (component) => {\n      // this includes non executables, like `button.compositions.module.scss` or `presets.compositions.json`\n      const compositionFiles = component.state.filesystem.byGlob(this.compositionFilePattern);\n\n      // select only relevant preview files (.tsx, etc)\n      const previewFiles = new Set(\n        component.state.filesystem.byGlob(this.previewFilePattern).map((file) => file.relative)\n      );\n      const files = compositionFiles.filter((file) => previewFiles.has(file.relative));\n\n      return files;\n    });\n  }\n\n  /**\n   * get component compositions.\n   */\n  getCompositions(component: Component): Composition[] {\n    const entry = component.state.aspects.get(CompositionsAspect.id);\n    if (!entry) return [];\n    const compositions = entry.data.compositions;\n    if (!compositions) return [];\n\n    return Composition.fromArray(compositions);\n  }\n\n  /**\n   * read composition from the component source code.\n   */\n  readCompositions(component: Component): Composition[] {\n    const maybeFiles = this.getPreviewFiles([component]).byComponent(component);\n\n    if (!maybeFiles) return [];\n    const [, files] = maybeFiles;\n    return flatten(\n      files.map((file) => {\n        return this.computeCompositions(component, file);\n      })\n    );\n  }\n\n  async onComponentLoad(component: Component): Promise<AspectData> {\n    const compositions = this.readCompositions(component);\n    return {\n      compositions: compositions.map((composition) => composition.toObject()),\n    };\n  }\n\n  private computeCompositions(component: Component, file: AbstractVinyl): Composition[] {\n    // :TODO hacked for a specific file extension now until david will take care in the compiler.\n    const pathArray = file.path.split('.');\n    pathArray[pathArray.length - 1] = 'js';\n\n    const module = this.schema.parseModule(join(this.workspace.componentDir(component.id), file.relative));\n    return module.exports.map((exportModel) => {\n      const displayName = exportModel.staticProperties?.get('compositionName');\n\n      return new Composition(\n        exportModel.identifier,\n        file.relative,\n        typeof displayName === 'string' ? displayName : undefined\n      );\n    });\n  }\n\n  static defaultConfig: CompositionsConfig = {\n    compositionFilePattern: ['**/*.composition?(s).*'],\n    compositionPreviewFilePattern: ['**/*.{t,j}s?(x)'],\n  };\n\n  static runtime = MainRuntime;\n  static dependencies = [PreviewAspect, GraphqlAspect, WorkspaceAspect, SchemaAspect, DevFilesAspect, ComponentAspect];\n\n  static async provider(\n    [preview, graphql, workspace, schema, devFiles]: [PreviewMain, GraphqlMain, Workspace, SchemaMain, DevFilesMain],\n    config: CompositionsConfig\n  ) {\n    const compositions = new CompositionsMain(\n      config.compositionFilePattern,\n      config.compositionPreviewFilePattern,\n      preview,\n      workspace,\n      schema,\n      devFiles\n    );\n    devFiles.registerDevPattern(config.compositionFilePattern);\n\n    graphql.register(compositionsSchema(compositions));\n    preview.registerDefinition(new CompositionPreviewDefinition(compositions));\n\n    if (workspace) {\n      workspace.onComponentLoad(compositions.onComponentLoad.bind(compositions));\n    }\n\n    return compositions;\n  }\n}\n\nCompositionsAspect.addRuntime(CompositionsMain);\n"]}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/compositions",
-  "version": "0.0.522",
+  "version": "0.0.526",
   "homepage": "https://bit.dev/teambit/compositions/compositions",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compositions",
     "name": "compositions",
-    "version": "0.0.522"
+    "version": "0.0.526"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -23,32 +23,32 @@
     "@teambit/documenter.ui.heading": "4.1.1",
     "@teambit/documenter.ui.property-table": "4.1.3",
     "@teambit/evangelist.elements.icon": "1.0.2",
-    "@teambit/component": "0.0.522",
-    "@teambit/compositions.model.composition-id": "0.0.445",
-    "@teambit/graphql": "0.0.522",
-    "@teambit/cli": "0.0.379",
-    "@teambit/dev-files": "0.0.522",
-    "@teambit/preview": "0.0.522",
-    "@teambit/schema": "0.0.522",
-    "@teambit/workspace": "0.0.522",
-    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.445",
-    "@teambit/envs": "0.0.522",
-    "@teambit/compositions.ui.compositions-menu-bar": "0.0.122",
-    "@teambit/compositions.ui.hooks.use-composition": "0.0.122",
-    "@teambit/design.ui.alert-card": "0.0.12",
-    "@teambit/design.ui.empty-box": "0.0.351",
-    "@teambit/design.ui.input.option-button": "0.0.25",
-    "@teambit/design.ui.separator": "0.0.350",
-    "@teambit/design.ui.surfaces.status-message-card": "0.0.5",
-    "@teambit/docs.ui.queries.get-docs": "0.0.445",
-    "@teambit/mdx.ui.mdx-layout": "0.0.447",
-    "@teambit/panels": "0.0.379",
-    "@teambit/preview.ui.component-preview": "0.0.445",
-    "@teambit/ui-foundation.ui.buttons.collapser": "0.0.150",
-    "@teambit/ui-foundation.ui.hooks.use-is-mobile": "0.0.138",
-    "@teambit/ui": "0.0.522",
-    "@teambit/compositions.model.composition-type": "0.0.445",
-    "@teambit/compositions.ui.composition-card": "0.0.449"
+    "@teambit/component": "0.0.526",
+    "@teambit/compositions.model.composition-id": "0.0.447",
+    "@teambit/graphql": "0.0.526",
+    "@teambit/cli": "0.0.380",
+    "@teambit/dev-files": "0.0.526",
+    "@teambit/preview": "0.0.526",
+    "@teambit/schema": "0.0.526",
+    "@teambit/workspace": "0.0.526",
+    "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.447",
+    "@teambit/envs": "0.0.526",
+    "@teambit/compositions.ui.compositions-menu-bar": "0.0.124",
+    "@teambit/compositions.ui.hooks.use-composition": "0.0.124",
+    "@teambit/design.ui.alert-card": "0.0.13",
+    "@teambit/design.ui.empty-box": "0.0.352",
+    "@teambit/design.ui.input.option-button": "0.0.26",
+    "@teambit/design.ui.separator": "0.0.351",
+    "@teambit/design.ui.surfaces.status-message-card": "0.0.6",
+    "@teambit/docs.ui.queries.get-docs": "0.0.447",
+    "@teambit/mdx.ui.mdx-layout": "0.0.450",
+    "@teambit/panels": "0.0.380",
+    "@teambit/preview.ui.component-preview": "0.0.447",
+    "@teambit/ui-foundation.ui.buttons.collapser": "0.0.152",
+    "@teambit/ui-foundation.ui.hooks.use-is-mobile": "0.0.140",
+    "@teambit/ui": "0.0.526",
+    "@teambit/compositions.model.composition-type": "0.0.448",
+    "@teambit/compositions.ui.composition-card": "0.0.452"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -59,14 +59,14 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/compositions.aspect-docs.compositions": "0.0.85"
+    "@teambit/compositions.aspect-docs.compositions": "0.0.88"
   },
   "peerDependencies": {
     "@teambit/legacy": "1.0.76",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "bit": {
     "bindingPrefix": "@teambit",
     "env": {},