@opensumi/ide-static-resource 2.21.13 → 2.22.0

package/lib/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":";;;;AAAA,qCAA+D;AAC/D,iEAAgH;AAEhH,2DAAwF;AACxF,qDAA6D;AAC7D,8DAAoC;AAGpC,IAAa,oBAAoB,GAAjC,MAAa,oBAAqB,SAAQ,gCAAa;IAAvD;;QACE,cAAS,GAAe;YACtB;gBACE,KAAK,EAAE,yCAAqB;gBAC5B,QAAQ,EAAE,0CAAyB;aACpC;YACD,mCAAmC;SACpC,CAAC;QAEF,yBAAoB,GAAG,8CAA0B,CAAC;IACpD,CAAC;CAAA,CAAA;AAVY,oBAAoB;IADhC,IAAA,eAAU,GAAE;GACA,oBAAoB,CAUhC;AAVY,oDAAoB;AAajC,IAAa,mCAAmC,GAAhD,MAAa,mCAAmC;IAO9C,UAAU;QACR,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE;YAChE,YAAY,CAAC,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;SACjE;IACH,CAAC;CACF,CAAA;AAVC;IADC,IAAA,cAAS,GAAE;sCAC4B,yCAAqB;kFAAC;AAG9D;IADC,IAAA,cAAS,EAAC,8CAA0B,CAAC;;0EAC2C;AALtE,mCAAmC;IAD/C,IAAA,yBAAM,EAAC,wCAAqB,CAAC;GACjB,mCAAmC,CAY/C;AAZY,kFAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/browser/index.ts"],"names":[],"mappings":";;;;AAAA,qCAA+D;AAC/D,iEAAgH;AAEhH,2DAAwF;AACxF,qDAA6D;AAC7D,8DAAoC;AAG7B,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,gCAAa;IAAhD;;QACL,cAAS,GAAe;YACtB;gBACE,KAAK,EAAE,yCAAqB;gBAC5B,QAAQ,EAAE,0CAAyB;aACpC;YACD,mCAAmC;SACpC,CAAC;QAEF,yBAAoB,GAAG,8CAA0B,CAAC;IACpD,CAAC;CAAA,CAAA;AAVY,oBAAoB;IADhC,IAAA,eAAU,GAAE;GACA,oBAAoB,CAUhC;AAVY,oDAAoB;AAa1B,IAAM,mCAAmC,GAAzC,MAAM,mCAAmC;IAO9C,UAAU;QACR,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,EAAE;YAChE,YAAY,CAAC,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;SACjE;IACH,CAAC;CACF,CAAA;AAXC;IAAC,IAAA,cAAS,GAAE;sCAC4B,yCAAqB;kFAAC;AAE9D;IAAC,IAAA,cAAS,EAAC,8CAA0B,CAAC;;0EAC2C;AALtE,mCAAmC;IAD/C,IAAA,yBAAM,EAAC,wCAAqB,CAAC;GACjB,mCAAmC,CAY/C;AAZY,kFAAmC"}

package/lib/browser/static.definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"static.definition.js","sourceRoot":"","sources":["../../src/browser/static.definition.ts"],"names":[],"mappings":";;;;AAAA,qCAA0C;AAG1C;;;;;;;;;GASG;AAEH,IAAsB,qBAAqB,GAA3C,MAAsB,qBAAqB;CAuB1C,CAAA;AAvBqB,qBAAqB;IAD1C,IAAA,eAAU,GAAE;GACS,qBAAqB,CAuB1C;AAvBqB,sDAAqB;AAiD9B,QAAA,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAC;AAElE,QAAA,kCAAkC,GAAG,MAAM,CAAC,oCAAoC,CAAC,CAAC"}
+{"version":3,"file":"static.definition.js","sourceRoot":"","sources":["../../src/browser/static.definition.ts"],"names":[],"mappings":";;;;AAAA,qCAA0C;AAG1C;;;;;;;;;GASG;AAEI,IAAe,qBAAqB,GAApC,MAAe,qBAAqB;CAuB1C,CAAA;AAvBqB,qBAAqB;IAD1C,IAAA,eAAU,GAAE;GACS,qBAAqB,CAuB1C;AAvBqB,sDAAqB;AAiD9B,QAAA,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAC;AAElE,QAAA,kCAAkC,GAAG,MAAM,CAAC,oCAAoC,CAAC,CAAC"}

package/lib/browser/static.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"static.service.js","sourceRoot":"","sources":["../../src/browser/static.service.ts"],"names":[],"mappings":";;;;AAAA,qCAA0C;AAM1C,IAAa,yBAAyB,GAAtC,MAAa,yBAAyB;IAAtC;QACU,cAAS,GAAG,IAAI,GAAG,EAAmC,CAAC;QAE/C,kBAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;IA2BzD,CAAC;IAzBQ,8BAA8B,CAAC,QAAiC;QACrE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,KAAK,EAAE;YAClB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC9B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;SACJ;QACD,OAAO;YACL,OAAO,EAAE,GAAG,EAAE;gBACZ,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE;oBACpD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;iBACxC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,GAAQ;QACnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnC,OAAO,GAAG,CAAC;SACZ;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACvE,kCAAkC;QAClC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,GAAG,CAAC;IACb,CAAC;CACF,CAAA;AA9BY,yBAAyB;IADrC,IAAA,eAAU,GAAE;GACA,yBAAyB,CA8BrC;AA9BY,8DAAyB"}
+{"version":3,"file":"static.service.js","sourceRoot":"","sources":["../../src/browser/static.service.ts"],"names":[],"mappings":";;;;AAAA,qCAA0C;AAMnC,IAAM,yBAAyB,GAA/B,MAAM,yBAAyB;IAA/B;QACG,cAAS,GAAG,IAAI,GAAG,EAAmC,CAAC;QAE/C,kBAAa,GAAgB,IAAI,GAAG,EAAE,CAAC;IA2BzD,CAAC;IAzBQ,8BAA8B,CAAC,QAAiC;QACrE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,KAAK,EAAE;YAClB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC9B,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;SACJ;QACD,OAAO;YACL,OAAO,EAAE,GAAG,EAAE;gBACZ,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE;oBACpD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;iBACxC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,GAAQ;QACnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnC,OAAO,GAAG,CAAC;SACZ;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACvE,kCAAkC;QAClC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,GAAG,CAAC;IACb,CAAC;CACF,CAAA;AA9BY,yBAAyB;IADrC,IAAA,eAAU,GAAE;GACA,yBAAyB,CA8BrC;AA9BY,8DAAyB"}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@opensumi/ide-static-resource",
-  "version": "2.21.13",
+  "version": "2.22.0",
   "files": [
-    "lib"
+    "lib",
+    "src"
   ],
   "license": "MIT",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "scripts": {
-    "prepublishOnly": "npm run build",
+    "prepublishOnly": "yarn run build",
     "build": "tsc --build ../../configs/ts/references/tsconfig.static-resource.json"
   },
   "repository": {
@@ -16,8 +17,8 @@
     "url": "git@github.com:opensumi/core.git"
   },
   "devDependencies": {
-    "@opensumi/ide-core-browser": "2.21.13",
-    "@opensumi/ide-dev-tool": "^1.3.1"
+    "@opensumi/ide-core-browser": "2.22.0",
+    "@opensumi/ide-dev-tool": "1.3.1"
   },
-  "gitHead": "1480afacfef7ef11eae65c5cbbddce416f227fe8"
+  "gitHead": "927717e1c60f9cf5f01622fd51085b318a175eeb"
 }

package/src/browser/index.ts

@@ -0,0 +1,34 @@
+import { Injectable, Provider, Autowired } from '@opensumi/di';
+import { BrowserModule, Domain, ContributionProvider, ClientAppContribution } from '@opensumi/ide-core-browser';
+
+import { StaticResourceService, StaticResourceContribution } from './static.definition';
+import { StaticResourceServiceImpl } from './static.service';
+export * from './static.definition';
+
+@Injectable()
+export class StaticResourceModule extends BrowserModule {
+  providers: Provider[] = [
+    {
+      token: StaticResourceService,
+      useClass: StaticResourceServiceImpl,
+    },
+    StaticResourceClientAppContribution,
+  ];
+
+  contributionProvider = StaticResourceContribution;
+}
+
+@Domain(ClientAppContribution)
+export class StaticResourceClientAppContribution implements ClientAppContribution {
+  @Autowired()
+  private readonly staticResourceService: StaticResourceService;
+
+  @Autowired(StaticResourceContribution)
+  private readonly contributions: ContributionProvider<StaticResourceContribution>;
+
+  initialize() {
+    for (const contribution of this.contributions.getContributions()) {
+      contribution.registerStaticResolver(this.staticResourceService);
+    }
+  }
+}

package/src/browser/static.definition.ts

@@ -0,0 +1,70 @@
+import { Injectable } from '@opensumi/di';
+import { URI, IDisposable } from '@opensumi/ide-core-browser';
+
+/**
+ * @class StaticResourceService 静态资源转换服务
+ * @description
+ * 对于一些静态资源的展示，如图片，插件中的资源等等，在IDE中往往会以类似File协议的uri进行描述。
+ *
+ * 在WebIDE环境，我们无法将它直接挂载在对应的html标签或者css中。
+ * 因此在使用之前，需要将这些资源的URI转换为浏览器可以访问的资源。
+ *
+ * 在Electron中，由于File协议能直接访问，一般来说无需注册资源地址转换。
+ */
+@Injectable()
+export abstract class StaticResourceService {
+  /**
+   * 注册一个静态资源转换方式的提供方
+   * @param provider
+   */
+  public abstract registerStaticResourceProvider(provider: IStaticResourceProvider): IDisposable;
+
+  /**
+   * 将URI资源转换为静态资源
+   * 通常比如在WebIDE场景, 会将插件的file://路径，转换为某个静态服务的uri进行访问
+   * @param uri 待转换的uri
+   * @returns 转换后的uri
+   */
+  public abstract resolveStaticResource(uri: URI): URI;
+
+  /**
+   * 被转换后的uri将会拥有哪些host,
+   * 用于webview的cspResource字段,
+   * webview需要能够知道什么样的资源是可以被访问的。
+   *
+   * 例: ['http://127.0.0.1:8000']
+   */
+  public readonly resourceRoots: Set<string>;
+}
+
+/**
+ * @interface 提供静态资源转换方式的提供方
+ *
+ */
+export interface IStaticResourceProvider {
+  /**
+   * 能够处理的scheme，单个scheme只能有一个StaticResourceProvider， 先来的会被后来的覆盖
+   */
+  scheme: string;
+
+  /**
+   * 定义如何处理uri的转换
+   * @param uri 待转换的uri
+   */
+  resolveStaticResource(uri: URI): URI;
+
+  /**
+   * resolve后提供的外部资源的host路径， 会传入StaticResourceService的resourceRoots中
+   *
+   * 例: ['http://0.0.0.0:8000']
+   */
+  roots?: string[];
+}
+
+export const StaticResourceContribution = Symbol('StaticResourceContribution');
+
+export const StaticResourceContributionProvider = Symbol('StaticResourceContributionProvider');
+
+export interface StaticResourceContribution {
+  registerStaticResolver(service: StaticResourceService): void;
+}

package/src/browser/static.service.ts

@@ -0,0 +1,37 @@
+import { Injectable } from '@opensumi/di';
+import { URI } from '@opensumi/ide-core-browser';
+
+import { StaticResourceService, IStaticResourceProvider } from './static.definition';
+
+@Injectable()
+export class StaticResourceServiceImpl implements StaticResourceService {
+  private providers = new Map<string, IStaticResourceProvider>();
+
+  public readonly resourceRoots: Set<string> = new Set();
+
+  public registerStaticResourceProvider(provider: IStaticResourceProvider) {
+    this.providers.set(provider.scheme, provider);
+    if (provider.roots) {
+      provider.roots.forEach((root) => {
+        this.resourceRoots.add(root);
+      });
+    }
+    return {
+      dispose: () => {
+        if (this.providers.get(provider.scheme) === provider) {
+          this.providers.delete(provider.scheme);
+        }
+      },
+    };
+  }
+
+  public resolveStaticResource(uri: URI): URI {
+    if (!this.providers.has(uri.scheme)) {
+      return uri;
+    }
+    const url = this.providers.get(uri.scheme)!.resolveStaticResource(uri);
+    // vscode-url path的 = 会被转码，先手动跳过转码
+    url.toString = url.toString.bind(url, true);
+    return url;
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './browser';