ember-repl 4.0.2 → 4.0.3

package/dist/compile/index.js

@@ -0,0 +1,113 @@
+import { resourceFactory, resource, cell } from 'ember-resources';
+import { compileMD, compileGJS, compileHBS } from './formats.js';
+import { nameFor } from './utils.js';
+
+const CACHE = new Map();
+const SUPPORTED_FORMATS = ['glimdown', 'gjs', 'hbs'];
+
+/**
+ * Compile GitHub-flavored Markdown with GJS support
+ * and optionally render gjs-snippets via a `live` meta tag
+ * on the code fences.
+ */
+
+/**
+ * Compile GJS
+ */
+
+/**
+ * Compile a stateless component using just the template
+ */
+
+/**
+ * This compileMD is a more robust version of the raw compiling used in "formats".
+ * This function manages cache, and has events for folks building UIs to hook in to
+ */
+async function compile(text, options) {
+  let {
+    onSuccess,
+    onError,
+    onCompileStart
+  } = options;
+  let id = nameFor(text);
+  let existing = CACHE.get(id);
+  if (existing) {
+    onSuccess(existing);
+    return;
+  }
+  if (!SUPPORTED_FORMATS.includes(options.format)) {
+    await onError(`Unsupported format: ${options.format}. Supported formats: ${SUPPORTED_FORMATS}`);
+    return;
+  }
+  await onCompileStart();
+  if (!text) {
+    await onError('No Input Document yet');
+    return;
+  }
+  let result;
+  if (options.format === 'glimdown') {
+    result = await compileMD(text, options);
+  } else if (options.format === 'gjs') {
+    result = await compileGJS(text, options.importMap);
+  } else if (options.format === 'hbs') {
+    result = await compileHBS(text, {
+      scope: options.topLevelScope
+    });
+  } else {
+    await onError(`Unsupported format: ${options.format}. Supported formats: ${SUPPORTED_FORMATS}`);
+    return;
+  }
+  if (result.error) {
+    await onError(result.error.message || `${result.error}`);
+    return;
+  }
+  CACHE.set(id, result.component);
+  await onSuccess(result.component);
+}
+
+/**
+ * @internal
+ */
+
+/**
+ * By default, this compiles to `glimdown`. A Markdown format which
+ * extracts `live` tagged code snippets and compiles them to components.
+ */
+function Compiled(markdownText, maybeOptions) {
+  return resource(() => {
+    let maybeObject = typeof maybeOptions === 'function' ? maybeOptions() : maybeOptions;
+    let format = (typeof maybeObject === 'string' ? maybeObject : maybeObject?.format) || 'glimdown';
+    let options = (typeof maybeObject === 'string' ? {} : maybeObject) || {};
+    let input = typeof markdownText === 'function' ? markdownText() : markdownText;
+    let ready = cell(false);
+    let error = cell();
+    let result = cell();
+    if (input) {
+      compile(input, {
+        // narrowing is hard here, but this is an implementation detail
+        format: format,
+        onSuccess: async component => {
+          result.current = component;
+          ready.set(true);
+          error.set(null);
+        },
+        onError: async e => {
+          error.set(e);
+        },
+        onCompileStart: async () => {
+          ready.set(false);
+        },
+        ...options
+      });
+    }
+    return () => ({
+      isReady: ready.current,
+      error: error.current,
+      component: result.current
+    });
+  });
+}
+resourceFactory(Compiled);
+
+export { CACHE, Compiled, compile };
+//# sourceMappingURL=index.js.map

package/dist/compile/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/compile/index.ts"],"sourcesContent":["import { cell, resource, resourceFactory } from 'ember-resources';\n\nimport {\n  compileGJS as processGJS,\n  compileHBS as processHBS,\n  compileMD as processMD,\n} from './formats.ts';\nimport { nameFor } from './utils.ts';\n\nimport type { CompileResult, UnifiedPlugin } from './types.ts';\nimport type { EvalImportMap, ScopeMap } from './types.ts';\nimport type { ComponentLike } from '@glint/template';\ntype Format = 'glimdown' | 'gjs' | 'hbs';\n\nexport const CACHE = new Map<string, ComponentLike>();\n\ninterface Events {\n  onSuccess: (component: ComponentLike) => Promise<unknown> | unknown;\n  onError: (error: string) => Promise<unknown> | unknown;\n  onCompileStart: () => Promise<unknown> | unknown;\n}\n\ninterface Scope {\n  importMap?: EvalImportMap;\n}\n\nconst SUPPORTED_FORMATS = ['glimdown', 'gjs', 'hbs'];\n\ninterface GlimdownOptions extends Scope, Events {\n  format: 'glimdown';\n  remarkPlugins?: UnifiedPlugin[];\n  rehypePlugins?: UnifiedPlugin[];\n  CopyComponent?: string;\n  ShadowComponent?: string;\n  topLevelScope?: ScopeMap;\n}\ninterface GJSOptions extends Scope, Events {\n  format: 'gjs';\n}\n\ninterface HBSOptions extends Scope, Events {\n  format: 'hbs';\n  topLevelScope?: ScopeMap;\n}\n\n/**\n * Compile GitHub-flavored Markdown with GJS support\n * and optionally render gjs-snippets via a `live` meta tag\n * on the code fences.\n */\nexport async function compile(text: string, options: GlimdownOptions): Promise<void>;\n\n/**\n * Compile GJS\n */\nexport async function compile(text: string, options: GJSOptions): Promise<void>;\n\n/**\n * Compile a stateless component using just the template\n */\nexport async function compile(text: string, options: HBSOptions): Promise<void>;\n\n/**\n * This compileMD is a more robust version of the raw compiling used in \"formats\".\n * This function manages cache, and has events for folks building UIs to hook in to\n */\nexport async function compile(\n  text: string,\n  options: GlimdownOptions | GJSOptions | HBSOptions\n): Promise<void> {\n  let { onSuccess, onError, onCompileStart } = options;\n  let id = nameFor(text);\n\n  let existing = CACHE.get(id);\n\n  if (existing) {\n    onSuccess(existing);\n\n    return;\n  }\n\n  if (!SUPPORTED_FORMATS.includes(options.format)) {\n    await onError(`Unsupported format: ${options.format}. Supported formats: ${SUPPORTED_FORMATS}`);\n\n    return;\n  }\n\n  await onCompileStart();\n\n  if (!text) {\n    await onError('No Input Document yet');\n\n    return;\n  }\n\n  let result: CompileResult;\n\n  if (options.format === 'glimdown') {\n    result = await processMD(text, options);\n  } else if (options.format === 'gjs') {\n    result = await processGJS(text, options.importMap);\n  } else if (options.format === 'hbs') {\n    result = await processHBS(text, {\n      scope: options.topLevelScope,\n    });\n  } else {\n    await onError(\n      `Unsupported format: ${(options as any).format}. Supported formats: ${SUPPORTED_FORMATS}`\n    );\n\n    return;\n  }\n\n  if (result.error) {\n    await onError(result.error.message || `${result.error}`);\n\n    return;\n  }\n\n  CACHE.set(id, result.component as ComponentLike);\n\n  await onSuccess(result.component as ComponentLike);\n}\n\ntype Input = string | undefined | null;\n\ntype ExtraOptions =\n  | {\n      format: 'glimdown';\n      remarkPlugins?: UnifiedPlugin[];\n      importMap?: EvalImportMap;\n      CopyComponent?: string;\n      ShadowComponent?: string;\n      topLevelScope?: ScopeMap;\n    }\n  | {\n      format: 'hbs';\n      topLevelScope?: ScopeMap;\n    }\n  | {\n      format: 'gjs';\n      importMap?: EvalImportMap;\n    };\n\n/**\n * @internal\n */\nexport interface Value {\n  isReady: boolean;\n  error: string | null;\n  component: ComponentLike;\n}\n\nexport function Compiled(markdownText: Input | (() => Input)): Value;\nexport function Compiled(markdownText: Input | (() => Input), options?: Format): Value;\nexport function Compiled(markdownText: Input | (() => Input), options?: () => Format): Value;\nexport function Compiled(markdownText: Input | (() => Input), options?: ExtraOptions): Value;\nexport function Compiled(markdownText: Input | (() => Input), options?: () => ExtraOptions): Value;\n\n/**\n * By default, this compiles to `glimdown`. A Markdown format which\n * extracts `live` tagged code snippets and compiles them to components.\n */\nexport function Compiled(\n  markdownText: Input | (() => Input),\n  maybeOptions?: Format | (() => Format) | ExtraOptions | (() => ExtraOptions)\n): Value {\n  return resource(() => {\n    let maybeObject = typeof maybeOptions === 'function' ? maybeOptions() : maybeOptions;\n    let format =\n      (typeof maybeObject === 'string' ? maybeObject : maybeObject?.format) || 'glimdown';\n    let options = (typeof maybeObject === 'string' ? {} : maybeObject) || {};\n\n    let input = typeof markdownText === 'function' ? markdownText() : markdownText;\n    let ready = cell(false);\n    let error = cell<string | null>();\n    let result = cell<ComponentLike>();\n\n    if (input) {\n      compile(input, {\n        // narrowing is hard here, but this is an implementation detail\n        format: format as any,\n        onSuccess: async (component) => {\n          result.current = component;\n          ready.set(true);\n          error.set(null);\n        },\n        onError: async (e) => {\n          error.set(e);\n        },\n        onCompileStart: async () => {\n          ready.set(false);\n        },\n        ...options,\n      });\n    }\n\n    return () => ({\n      isReady: ready.current,\n      error: error.current,\n      component: result.current,\n    });\n  });\n}\n\nresourceFactory(Compiled);\n"],"names":["CACHE","Map","SUPPORTED_FORMATS","compile","text","options","onSuccess","onError","onCompileStart","id","nameFor","existing","get","includes","format","result","processMD","processGJS","importMap","processHBS","scope","topLevelScope","error","message","set","component","Compiled","markdownText","maybeOptions","resource","maybeObject","input","ready","cell","current","e","isReady","resourceFactory"],"mappings":";;;;MAcaA,KAAK,GAAG,IAAIC,GAAG,GAAyB;AAYrD,MAAMC,iBAAiB,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;;AAmBpD;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;;AAGA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACO,eAAeC,OAAOA,CAC3BC,IAAY,EACZC,OAAkD,EACnC;EACf,IAAI;IAAEC,SAAS;IAAEC,OAAO;AAAEC,IAAAA,cAAAA;AAAe,GAAC,GAAGH,OAAO,CAAA;AACpD,EAAA,IAAII,EAAE,GAAGC,OAAO,CAACN,IAAI,CAAC,CAAA;AAEtB,EAAA,IAAIO,QAAQ,GAAGX,KAAK,CAACY,GAAG,CAACH,EAAE,CAAC,CAAA;AAE5B,EAAA,IAAIE,QAAQ,EAAE;IACZL,SAAS,CAACK,QAAQ,CAAC,CAAA;AAEnB,IAAA,OAAA;AACF,GAAA;EAEA,IAAI,CAACT,iBAAiB,CAACW,QAAQ,CAACR,OAAO,CAACS,MAAM,CAAC,EAAE;IAC/C,MAAMP,OAAO,CAAE,CAAsBF,oBAAAA,EAAAA,OAAO,CAACS,MAAO,CAAA,qBAAA,EAAuBZ,iBAAkB,CAAA,CAAC,CAAC,CAAA;AAE/F,IAAA,OAAA;AACF,GAAA;EAEA,MAAMM,cAAc,EAAE,CAAA;EAEtB,IAAI,CAACJ,IAAI,EAAE;IACT,MAAMG,OAAO,CAAC,uBAAuB,CAAC,CAAA;AAEtC,IAAA,OAAA;AACF,GAAA;AAEA,EAAA,IAAIQ,MAAqB,CAAA;AAEzB,EAAA,IAAIV,OAAO,CAACS,MAAM,KAAK,UAAU,EAAE;AACjCC,IAAAA,MAAM,GAAG,MAAMC,SAAS,CAACZ,IAAI,EAAEC,OAAO,CAAC,CAAA;AACzC,GAAC,MAAM,IAAIA,OAAO,CAACS,MAAM,KAAK,KAAK,EAAE;IACnCC,MAAM,GAAG,MAAME,UAAU,CAACb,IAAI,EAAEC,OAAO,CAACa,SAAS,CAAC,CAAA;AACpD,GAAC,MAAM,IAAIb,OAAO,CAACS,MAAM,KAAK,KAAK,EAAE;AACnCC,IAAAA,MAAM,GAAG,MAAMI,UAAU,CAACf,IAAI,EAAE;MAC9BgB,KAAK,EAAEf,OAAO,CAACgB,aAAAA;AACjB,KAAC,CAAC,CAAA;AACJ,GAAC,MAAM;IACL,MAAMd,OAAO,CACV,CAAuBF,oBAAAA,EAAAA,OAAO,CAASS,MAAO,CAAA,qBAAA,EAAuBZ,iBAAkB,CAAA,CAC1F,CAAC,CAAA;AAED,IAAA,OAAA;AACF,GAAA;EAEA,IAAIa,MAAM,CAACO,KAAK,EAAE;AAChB,IAAA,MAAMf,OAAO,CAACQ,MAAM,CAACO,KAAK,CAACC,OAAO,IAAK,CAAER,EAAAA,MAAM,CAACO,KAAM,EAAC,CAAC,CAAA;AAExD,IAAA,OAAA;AACF,GAAA;EAEAtB,KAAK,CAACwB,GAAG,CAACf,EAAE,EAAEM,MAAM,CAACU,SAA0B,CAAC,CAAA;AAEhD,EAAA,MAAMnB,SAAS,CAACS,MAAM,CAACU,SAA0B,CAAC,CAAA;AACpD,CAAA;;AAsBA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACO,SAASC,QAAQA,CACtBC,YAAmC,EACnCC,YAA4E,EACrE;EACP,OAAOC,QAAQ,CAAC,MAAM;IACpB,IAAIC,WAAW,GAAG,OAAOF,YAAY,KAAK,UAAU,GAAGA,YAAY,EAAE,GAAGA,YAAY,CAAA;AACpF,IAAA,IAAId,MAAM,GACR,CAAC,OAAOgB,WAAW,KAAK,QAAQ,GAAGA,WAAW,GAAGA,WAAW,EAAEhB,MAAM,KAAK,UAAU,CAAA;AACrF,IAAA,IAAIT,OAAO,GAAG,CAAC,OAAOyB,WAAW,KAAK,QAAQ,GAAG,EAAE,GAAGA,WAAW,KAAK,EAAE,CAAA;IAExE,IAAIC,KAAK,GAAG,OAAOJ,YAAY,KAAK,UAAU,GAAGA,YAAY,EAAE,GAAGA,YAAY,CAAA;AAC9E,IAAA,IAAIK,KAAK,GAAGC,IAAI,CAAC,KAAK,CAAC,CAAA;AACvB,IAAA,IAAIX,KAAK,GAAGW,IAAI,EAAiB,CAAA;AACjC,IAAA,IAAIlB,MAAM,GAAGkB,IAAI,EAAiB,CAAA;AAElC,IAAA,IAAIF,KAAK,EAAE;MACT5B,OAAO,CAAC4B,KAAK,EAAE;AACb;AACAjB,QAAAA,MAAM,EAAEA,MAAa;QACrBR,SAAS,EAAE,MAAOmB,SAAS,IAAK;UAC9BV,MAAM,CAACmB,OAAO,GAAGT,SAAS,CAAA;AAC1BO,UAAAA,KAAK,CAACR,GAAG,CAAC,IAAI,CAAC,CAAA;AACfF,UAAAA,KAAK,CAACE,GAAG,CAAC,IAAI,CAAC,CAAA;SAChB;QACDjB,OAAO,EAAE,MAAO4B,CAAC,IAAK;AACpBb,UAAAA,KAAK,CAACE,GAAG,CAACW,CAAC,CAAC,CAAA;SACb;QACD3B,cAAc,EAAE,YAAY;AAC1BwB,UAAAA,KAAK,CAACR,GAAG,CAAC,KAAK,CAAC,CAAA;SACjB;QACD,GAAGnB,OAAAA;AACL,OAAC,CAAC,CAAA;AACJ,KAAA;AAEA,IAAA,OAAO,OAAO;MACZ+B,OAAO,EAAEJ,KAAK,CAACE,OAAO;MACtBZ,KAAK,EAAEA,KAAK,CAACY,OAAO;MACpBT,SAAS,EAAEV,MAAM,CAACmB,OAAAA;AACpB,KAAC,CAAC,CAAA;AACJ,GAAC,CAAC,CAAA;AACJ,CAAA;AAEAG,eAAe,CAACX,QAAQ,CAAC;;;;"}

package/dist/compile/types.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=types.js.map

package/dist/compile/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/compile/utils.js

@@ -0,0 +1,46 @@
+import { assert } from '@ember/debug';
+import { pascalCase } from 'change-case';
+import { v5 } from 'uuid';
+
+/**
+ * a namespace is required for uuid v5
+ *
+ * it helps generate stable outputs for for any given input.
+ */
+const NAMESPACE = '926f034a-f480-4112-a363-321244f4e5de';
+const DEFAULT_PREFIX = 'ember-repl';
+
+/**
+ * For any given code block, a reasonably stable name can be
+ * generated.
+ * This can help with cacheing previously compiled components,
+ * and generally allowing a consumer to derive "known references" to user-input
+ */
+function nameFor(code, prefix = DEFAULT_PREFIX) {
+  let id = v5(code, NAMESPACE);
+  return `${prefix ? `${prefix}-` : ''}${id}`;
+}
+
+/**
+ * Returns the text for invoking a component with a given name.
+ * It is assumed the component takes no arguments, as would be the
+ * case in REPLs / Playgrounds for the "root" component.
+ */
+function invocationOf(name) {
+  assert(`You must pass a name to invocationOf. Received: \`${name}\``, typeof name === 'string' && name.length > 0);
+  if (name.length === 0) {
+    throw new Error(`name passed to invocationOf must have non-0 length`);
+  }
+  return `<${invocationName(name)} />`;
+}
+
+/**
+ * Core team does not want to support changes to '@ember/string' (v2 addonification, specifically)
+ * inflection does not support hyphens
+ */
+function invocationName(name) {
+  return pascalCase(name).replaceAll('_', '');
+}
+
+export { invocationName, invocationOf, nameFor };
+//# sourceMappingURL=utils.js.map

package/dist/compile/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../../src/compile/utils.ts"],"sourcesContent":["import { assert } from '@ember/debug';\n\nimport { pascalCase } from 'change-case';\nimport { v5 as uuidv5 } from 'uuid';\n\n/**\n * a namespace is required for uuid v5\n *\n * it helps generate stable outputs for for any given input.\n */\nconst NAMESPACE = '926f034a-f480-4112-a363-321244f4e5de';\nconst DEFAULT_PREFIX = 'ember-repl';\n\n/**\n * For any given code block, a reasonably stable name can be\n * generated.\n * This can help with cacheing previously compiled components,\n * and generally allowing a consumer to derive \"known references\" to user-input\n */\nexport function nameFor(code: string, prefix = DEFAULT_PREFIX) {\n  let id = uuidv5(code, NAMESPACE);\n\n  return `${prefix ? `${prefix}-` : ''}${id}`;\n}\n\n/**\n * Returns the text for invoking a component with a given name.\n * It is assumed the component takes no arguments, as would be the\n * case in REPLs / Playgrounds for the \"root\" component.\n */\nexport function invocationOf(name: string) {\n  assert(\n    `You must pass a name to invocationOf. Received: \\`${name}\\``,\n    typeof name === 'string' && name.length > 0\n  );\n\n  if (name.length === 0) {\n    throw new Error(`name passed to invocationOf must have non-0 length`);\n  }\n\n  return `<${invocationName(name)} />`;\n}\n\n/**\n * Core team does not want to support changes to '@ember/string' (v2 addonification, specifically)\n * inflection does not support hyphens\n */\nexport function invocationName(name: string) {\n  return pascalCase(name).replaceAll('_', '');\n}\n"],"names":["NAMESPACE","DEFAULT_PREFIX","nameFor","code","prefix","id","uuidv5","invocationOf","name","assert","length","Error","invocationName","pascalCase","replaceAll"],"mappings":";;;;AAKA;AACA;AACA;AACA;AACA;AACA,MAAMA,SAAS,GAAG,sCAAsC,CAAA;AACxD,MAAMC,cAAc,GAAG,YAAY,CAAA;;AAEnC;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,OAAOA,CAACC,IAAY,EAAEC,MAAM,GAAGH,cAAc,EAAE;AAC7D,EAAA,IAAII,EAAE,GAAGC,EAAM,CAACH,IAAI,EAAEH,SAAS,CAAC,CAAA;EAEhC,OAAQ,CAAA,EAAEI,MAAM,GAAI,CAAEA,EAAAA,MAAO,GAAE,GAAG,EAAG,CAAEC,EAAAA,EAAG,CAAC,CAAA,CAAA;AAC7C,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACO,SAASE,YAAYA,CAACC,IAAY,EAAE;AACzCC,EAAAA,MAAM,CACH,CAAA,kDAAA,EAAoDD,IAAK,CAAA,EAAA,CAAG,EAC7D,OAAOA,IAAI,KAAK,QAAQ,IAAIA,IAAI,CAACE,MAAM,GAAG,CAC5C,CAAC,CAAA;AAED,EAAA,IAAIF,IAAI,CAACE,MAAM,KAAK,CAAC,EAAE;AACrB,IAAA,MAAM,IAAIC,KAAK,CAAE,CAAA,kDAAA,CAAmD,CAAC,CAAA;AACvE,GAAA;AAEA,EAAA,OAAQ,CAAGC,CAAAA,EAAAA,cAAc,CAACJ,IAAI,CAAE,CAAI,GAAA,CAAA,CAAA;AACtC,CAAA;;AAEA;AACA;AACA;AACA;AACO,SAASI,cAAcA,CAACJ,IAAY,EAAE;EAC3C,OAAOK,UAAU,CAACL,IAAI,CAAC,CAACM,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AAC7C;;;;"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { Compiled, compile } from './compile/index.js';
+export { invocationName, invocationOf, nameFor } from './compile/utils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/test-support/index.js

@@ -0,0 +1,8 @@
+import { CACHE } from '../compile/index.js';
+
+function clearCompileCache() {
+  CACHE.clear();
+}
+
+export { clearCompileCache };
+//# sourceMappingURL=index.js.map

package/dist/test-support/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/test-support/index.ts"],"sourcesContent":["import { CACHE } from '../compile/index.ts';\n\nexport function clearCompileCache() {\n  CACHE.clear();\n}\n"],"names":["clearCompileCache","CACHE","clear"],"mappings":";;AAEO,SAASA,iBAAiBA,GAAG;EAClCC,KAAK,CAACC,KAAK,EAAE,CAAA;AACf;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-repl",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "Addon for enabling REPL and Playground creation with Ember/Glimmer",
   "keywords": [
     "ember-addon"