@knapsack/types 4.69.9--canary.4768.997c53b.0 → 4.69.9--canary.4739.c87ad2d.0

package/dist/renderer-client-types.d.ts

@@ -19,15 +19,6 @@ export type KsRendererClientMsg = {
     msg: string;
     feedbackType?: FeedbackTypes;
 };
-/**
- * The meta data is stored in a script tag with this id
- * @see {KsRendererClientMeta}
- */
-export declare const ksRendererClientMetaId = "ks-meta";
-/**
- * Metadata about the current renderer client demo
- * @see {ksRendererClientMetaId} for the ID of the script tag
- */
 export interface KsRendererClientMeta {
     patternId: string;
     templateId: string;

package/dist/renderer-client-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer-client-types.d.ts","sourceRoot":"","sources":["../src/renderer-client-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C,oBAAY,sBAAsB;IAChC,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,IAAI,EAAE,4BAA4B,CAAC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEN;;;GAGG;AACH,eAAO,MAAM,sBAAsB,YAAY,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"renderer-client-types.d.ts","sourceRoot":"","sources":["../src/renderer-client-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C,oBAAY,sBAAsB;IAChC,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IACE,IAAI,EAAE,4BAA4B,CAAC;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEN,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB"}

package/dist/renderers.d.ts

@@ -13,6 +13,110 @@ export declare const rendererIds: {
  * @see {KnapsackPatternTemplate['templateLanguageId']}
  */
 export type RendererId = keyof typeof rendererIds;
+/**
+ * Information about JS imports that can describe how to import a module in these ways:
+ * - `import { Foo, Bar } from './foo';`
+ * - `import * as Foo from './foo';`
+ * - `import Foo from './foo';`
+ *
+ * Used in Webpack-based renderers
+ */
+export type KsJsImportInfo = {
+    type: 'default';
+    /** import name from 'path'; */
+    name: string;
+    path: string;
+} | {
+    type: 'named';
+    path: string;
+    /** import { name } from 'path'; */
+    name: string;
+} | {
+    type: 'all';
+    path: string;
+    /** import * as name from 'path'; */
+    name: string;
+};
+/** The result of `import`-ing a module */
+type EsModuleObject<ExportedType = unknown> = {
+    default?: ExportedType;
+    [key: string]: ExportedType;
+};
+export type KsJsImport = {
+    type: 'pattern-template';
+    patternId: string;
+    templateId: string;
+    importInfo: KsJsImportInfo;
+} | {
+    type: 'pattern-template-demo';
+    patternId: string;
+    templateId: string;
+    demoId: string;
+    importInfo: KsJsImportInfo;
+} | {
+    type: 'extra';
+    importInfo: KsJsImportInfo;
+};
+type GetKsJsImportParam = {
+    type: 'pattern-template';
+    patternId: string;
+    templateId: string;
+} | {
+    type: 'pattern-template-demo';
+    patternId: string;
+    templateId: string;
+    demoId: string;
+} | {
+    type: 'extra';
+    name: string;
+};
+type GetKsJsImportPatternParam = {
+    patternId: string;
+    templateId: string;
+    demoId?: string;
+};
+/**
+ * This is `window.knapsack` inside the renderer client: the iframe container for renderer components
+ */
+export interface KsRendererClientGlobal<ExportedComponentType = unknown> {
+    typeName: 'KsRendererClientGlobal';
+    importedModules: {
+        [id: string]: () => Promise<EsModuleObject<ExportedComponentType>>;
+    };
+    allAvailableImports: KsJsImport[];
+    getImport: (opt: GetKsJsImportParam) => Promise<{
+        name: string;
+        /** Most likely a component */
+        value: ExportedComponentType;
+    }>;
+    getImports: (imports: GetKsJsImportParam[]) => Promise<{
+        [importName: string]: ExportedComponentType;
+    }>;
+    getPatternImport: (opt: GetKsJsImportPatternParam) => Promise<{
+        name: string;
+        /** Most likely a component */
+        value: ExportedComponentType;
+    }>;
+    getExtraImport: (opt: {
+        name: string;
+    }) => Promise<{
+        name: string;
+        /** Most likely a component */
+        value: ExportedComponentType;
+    }>;
+    getAllImports: (opt: {
+        patterns: GetKsJsImportPatternParam[];
+        extras?: {
+            name: string;
+        }[];
+    }) => Promise<{
+        [importName: string]: ExportedComponentType;
+    }>;
+}
+export declare function isKsJsImports(imports: unknown): imports is KsJsImport[];
+export declare function isKsRendererClientGlobalImportedModules(mods: unknown): mods is KsRendererClientGlobal['importedModules'];
+export declare function isKsRendererClientGlobal<ExportedComponentType = unknown>(knapsack: unknown): knapsack is KsRendererClientGlobal<ExportedComponentType>;
+export declare function getKsRendererClientGlobal<ExportedComponentType = unknown>(): KsRendererClientGlobal<ExportedComponentType>;
 /**
  * Results of rendering a pattern
  */
@@ -46,4 +150,5 @@ export type TemplateSuggestionsGetFn = (opt: {
  * ```
  */
 export type PkgPathAliases = Record<string, string>;
+export {};
 //# sourceMappingURL=renderers.d.ts.map

package/dist/renderers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../src/renderers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW;;;;;;;;CAQd,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,WAAW,CAAC;AAClD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG;IACjD,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE;IAC3C,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,KAAK,OAAO,CAAC;IACZ,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}
+{"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../src/renderers.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW;;;;;;;;CAQd,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,WAAW,CAAC;AAElD;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GACtB;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEN,0CAA0C;AAC1C,KAAK,cAAc,CAAC,YAAY,GAAG,OAAO,IAAI;IAC5C,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,UAAU,GAClB;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,cAAc,CAAC;CAC5B,GACD;IACE,IAAI,EAAE,uBAAuB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,cAAc,CAAC;CAC5B,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,cAAc,CAAC;CAC5B,CAAC;AAEN,KAAK,kBAAkB,GACnB;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,uBAAuB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEN,KAAK,yBAAyB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,qBAAqB,GAAG,OAAO;IACrE,QAAQ,EAAE,wBAAwB,CAAC;IACnC,eAAe,EAAE;QACf,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,qBAAqB,CAAC,CAAC,CAAC;KACpE,CAAC;IACF,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAClC,SAAS,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,OAAO,CAAC;QAC9C,IAAI,EAAE,MAAM,CAAC;QACb,8BAA8B;QAC9B,KAAK,EAAE,qBAAqB,CAAC;KAC9B,CAAC,CAAC;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,kBAAkB,EAAE,KAAK,OAAO,CAAC;QACrD,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC;KAC7C,CAAC,CAAC;IACH,gBAAgB,EAAE,CAAC,GAAG,EAAE,yBAAyB,KAAK,OAAO,CAAC;QAC5D,IAAI,EAAE,MAAM,CAAC;QACb,8BAA8B;QAC9B,KAAK,EAAE,qBAAqB,CAAC;KAC9B,CAAC,CAAC;IACH,cAAc,EAAE,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC;QACjD,IAAI,EAAE,MAAM,CAAC;QACb,8BAA8B;QAC9B,KAAK,EAAE,qBAAqB,CAAC;KAC9B,CAAC,CAAC;IACH,aAAa,EAAE,CAAC,GAAG,EAAE;QACnB,QAAQ,EAAE,yBAAyB,EAAE,CAAC;QACtC,MAAM,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KAC7B,KAAK,OAAO,CAAC;QACZ,CAAC,UAAU,EAAE,MAAM,GAAG,qBAAqB,CAAC;KAC7C,CAAC,CAAC;CACJ;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,UAAU,EAAE,CA2CvE;AAED,wBAAgB,uCAAuC,CACrD,IAAI,EAAE,OAAO,GACZ,IAAI,IAAI,sBAAsB,CAAC,iBAAiB,CAAC,CAMnD;AAED,wBAAgB,wBAAwB,CAAC,qBAAqB,GAAG,OAAO,EACtE,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,sBAAsB,CAAC,qBAAqB,CAAC,CAS3D;AAKD,wBAAgB,yBAAyB,CACvC,qBAAqB,GAAG,OAAO,KAC5B,sBAAsB,CAAC,qBAAqB,CAAC,CAmBjD;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG;IACjD,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE;IAC3C,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,KAAK,OAAO,CAAC;IACZ,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@knapsack/types",
   "description": "",
-  "version": "4.69.9--canary.4768.997c53b.0",
+  "version": "4.69.9--canary.4739.c87ad2d.0",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -38,15 +38,15 @@
     "test": "ava"
   },
   "dependencies": {
-    "@knapsack/utils": "4.69.9--canary.4768.997c53b.0",
+    "@knapsack/utils": "4.69.9--canary.4739.c87ad2d.0",
     "color-string": "^1.9.1",
     "immer": "^10.0.4",
     "superstruct": "^0.16.7"
   },
   "devDependencies": {
-    "@knapsack/eslint-config-starter": "4.69.9--canary.4768.997c53b.0",
-    "@knapsack/test-ava": "4.69.9--canary.4768.997c53b.0",
-    "@knapsack/typescript-config-starter": "4.69.9--canary.4768.997c53b.0",
+    "@knapsack/eslint-config-starter": "4.69.9--canary.4739.c87ad2d.0",
+    "@knapsack/test-ava": "4.69.9--canary.4739.c87ad2d.0",
+    "@knapsack/typescript-config-starter": "4.69.9--canary.4739.c87ad2d.0",
     "@tiptap/core": "^2.6.6",
     "@types/color-string": "^1.5.5",
     "@types/fs-extra": "^11.0.4",
@@ -68,5 +68,5 @@
     "directory": "libs/types",
     "type": "git"
   },
-  "gitHead": "997c53b517d93e9800048817dbb4b781d7284977"
+  "gitHead": "c87ad2dec80acf383f6514c91e2a7504c618a84d"
 }