@croct/plug 0.11.4 → 0.11.6

package/component.d.ts

@@ -0,0 +1,16 @@
+import { CanonicalVersionId, Version, Versioned, VersionedId } from './versioning';
+export interface ComponentMap {
+}
+type LatestComponentVersionMap = {
+    [K in keyof ComponentMap]: {
+        latest: ComponentMap[K];
+    };
+};
+export interface VersionedComponentMap extends LatestComponentVersionMap {
+}
+export type ComponentId = keyof VersionedComponentMap extends never ? string : keyof VersionedComponentMap;
+export type ComponentVersion<I extends ComponentId = ComponentId> = Version<VersionedComponentMap, I>;
+export type ComponentVersionId<I extends ComponentId = ComponentId> = CanonicalVersionId<I, VersionedComponentMap>;
+export type VersionedComponentId<I extends ComponentId = ComponentId> = VersionedId<I, VersionedComponentMap>;
+export type ComponentContent<I extends VersionedComponentId> = Versioned<I, VersionedComponentMap>;
+export {};

package/component.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=component.js.map

package/component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.js","sourceRoot":"","sources":["src/component.ts"],"names":[],"mappings":""}

package/constants.d.ts

@@ -2,4 +2,4 @@ export declare const CDN_URL = "https://cdn.croct.io/js/v1/lib/plug.js";
 export declare const PLAYGROUND_ORIGIN = "https://play.croct.com";
 export declare const PLAYGROUND_CONNECT_URL = "https://play.croct.com/connect.html";
 export declare const PREVIEW_WIDGET_ORIGIN = "https://cdn.croct.io";
-export declare const PREVIEW_WIDGET_URL = "https://cdn.croct.io/js/v1/lib/plug/widget-0.11.4.html";
+export declare const PREVIEW_WIDGET_URL = "https://cdn.croct.io/js/v1/lib/plug/widget-0.11.6.html";

package/constants.js

@@ -5,5 +5,5 @@ exports.CDN_URL = 'https://cdn.croct.io/js/v1/lib/plug.js';
 exports.PLAYGROUND_ORIGIN = 'https://play.croct.com';
 exports.PLAYGROUND_CONNECT_URL = 'https://play.croct.com/connect.html';
 exports.PREVIEW_WIDGET_ORIGIN = 'https://cdn.croct.io';
-exports.PREVIEW_WIDGET_URL = 'https://cdn.croct.io/js/v1/lib/plug/widget-0.11.4.html';
+exports.PREVIEW_WIDGET_URL = 'https://cdn.croct.io/js/v1/lib/plug/widget-0.11.6.html';
 //# sourceMappingURL=constants.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@croct/plug",
-  "version": "0.11.4",
+  "version": "0.11.6",
   "description": "A fully-featured devkit for building natively personalized applications.",
   "license": "MIT",
   "author": {
@@ -33,8 +33,8 @@
     "bundle": "rollup -c"
   },
   "dependencies": {
-    "@croct/json": "^1.1.0",
-    "@croct/sdk": "^0.12.0",
+    "@croct/json": "^2.0.1",
+    "@croct/sdk": "^0.12.3",
     "tslib": "^2.2.0"
   },
   "devDependencies": {
@@ -42,8 +42,8 @@
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-replace": "^5.0.1",
-    "@rollup/plugin-terser": "^0.2.0",
-    "@rollup/plugin-typescript": "^10.0.0",
+    "@rollup/plugin-terser": "^0.3.0",
+    "@rollup/plugin-typescript": "^11.0.0",
     "@types/jest": "^29.2.2",
     "@typescript-eslint/parser": "^5.30.0",
     "eslint": "^8.27.0",
@@ -51,6 +51,7 @@
     "jest-environment-jsdom": "^29.3.1",
     "rollup": "^3.3.0",
     "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
   },
   "browserslist": [

package/slot.d.ts

@@ -1,4 +1,6 @@
 import { JsonObject } from '@croct/json';
+import { CanonicalVersionId, Version, Versioned, VersionedId } from './versioning';
+import { ComponentContent, ComponentVersionId } from './component';
 export interface SlotMap {
 }
 type LatestSlotVersionMap = {
@@ -8,14 +10,38 @@ type LatestSlotVersionMap = {
 };
 export interface VersionedSlotMap extends LatestSlotVersionMap {
 }
-type LatestAlias = 'latest';
+/**
+ * Creates an intersection of the given types distributing over unions.
+ *
+ * The difference between this type and the built-in `&` operator is that the
+ * `&` operator creates an intersection of the union members instead of
+ * creating a union of the intersection members. For example, given the types
+ * `Left = A | B` and `Right = C`, the type `Left & Right` expands to
+ * `(A | B) & C`, but `Merge<Left, Right>` expands to `A & C | B & C`,
+ * which improves type inference when narrowing the type.
+ */
+type Intersection<T, E> = T extends infer O ? O & E : never;
+type DiscriminatedSlotMap = {
+    [K in keyof VersionedSlotMap]: {
+        [V in keyof VersionedSlotMap[K]]: Intersection<VersionedSlotMap[K][V], {
+            _component: string | null;
+        }>;
+    };
+};
+type UnionContent = {
+    [K in ComponentVersionId]: Intersection<ComponentContent<K>, {
+        _component: K;
+    }>;
+};
+type UnknownContent = UnionContent[ComponentVersionId] extends never ? (JsonObject & {
+    _component: string | null;
+}) : UnionContent[ComponentVersionId];
+type VersionedContent<I extends VersionedSlotId> = Versioned<I, DiscriminatedSlotMap, UnknownContent>;
+export type DynamicSlotId = any;
 export type SlotId = keyof VersionedSlotMap extends never ? string : keyof VersionedSlotMap;
-export type SlotVersion<I extends SlotId = SlotId> = LatestAlias | (I extends keyof VersionedSlotMap ? keyof VersionedSlotMap[I] : never);
-export type VersionedSlotId<I extends SlotId = SlotId> = I | {
-    [K in SlotId]: `${K}@${SlotVersion<K> & string}`;
-}[I];
-type VersionedSlotContent<I extends SlotId, V extends string = LatestAlias, C extends JsonObject = JsonObject> = I extends keyof VersionedSlotMap ? (V extends keyof VersionedSlotMap[I] ? VersionedSlotMap[I][V] : C) : C;
-export type ExtractSlotVersion<I extends string> = I extends `${string}@${infer V}` ? (LatestAlias extends V ? LatestAlias : (V extends `${number}` ? V : never)) : LatestAlias;
-export type ExtractSlotId<I extends string> = I extends `${infer V}@${string}` ? V : I;
-export type SlotContent<I extends VersionedSlotId, C extends JsonObject = JsonObject> = VersionedSlotContent<ExtractSlotId<I>, ExtractSlotVersion<I>, C>;
+export type SlotVersion<I extends SlotId = SlotId> = Version<VersionedSlotMap, I>;
+export type SlotVersionId<I extends SlotId = SlotId> = CanonicalVersionId<I, VersionedSlotMap>;
+export type VersionedSlotId<I extends SlotId = SlotId> = VersionedId<I, VersionedSlotMap>;
+export type CompatibleSlotContent<T extends ComponentVersionId = ComponentVersionId> = UnionContent[T];
+export type SlotContent<I extends VersionedSlotId = VersionedSlotId, C extends JsonObject = JsonObject> = JsonObject extends C ? (string extends I ? UnknownContent : VersionedContent<I>) : C;
 export {};

package/src/component.ts

@@ -0,0 +1,19 @@
+import {CanonicalVersionId, Version, Versioned, VersionedId} from './versioning';
+
+export interface ComponentMap {
+}
+
+type LatestComponentVersionMap = {[K in keyof ComponentMap]: {latest: ComponentMap[K]}};
+
+export interface VersionedComponentMap extends LatestComponentVersionMap {
+}
+
+export type ComponentId = keyof VersionedComponentMap extends never ? string : keyof VersionedComponentMap;
+
+export type ComponentVersion<I extends ComponentId = ComponentId> = Version<VersionedComponentMap, I>;
+
+export type ComponentVersionId<I extends ComponentId = ComponentId> = CanonicalVersionId<I, VersionedComponentMap>;
+
+export type VersionedComponentId<I extends ComponentId = ComponentId> = VersionedId<I, VersionedComponentMap>;
+
+export type ComponentContent<I extends VersionedComponentId> = Versioned<I, VersionedComponentMap>;

package/src/slot.ts

@@ -1,4 +1,6 @@
 import {JsonObject} from '@croct/json';
+import {CanonicalVersionId, Version, Versioned, VersionedId} from './versioning';
+import {ComponentContent, ComponentVersionId} from './component';
 
 export interface SlotMap {
 }
@@ -8,30 +10,45 @@ type LatestSlotVersionMap = {[K in keyof SlotMap]: {latest: SlotMap[K]}};
 export interface VersionedSlotMap extends LatestSlotVersionMap {
 }
 
-type LatestAlias = 'latest';
+/**
+ * Creates an intersection of the given types distributing over unions.
+ *
+ * The difference between this type and the built-in `&` operator is that the
+ * `&` operator creates an intersection of the union members instead of
+ * creating a union of the intersection members. For example, given the types
+ * `Left = A | B` and `Right = C`, the type `Left & Right` expands to
+ * `(A | B) & C`, but `Merge<Left, Right>` expands to `A & C | B & C`,
+ * which improves type inference when narrowing the type.
+ */
+type Intersection<T, E> = T extends infer O ? O & E : never;
 
-export type SlotId = keyof VersionedSlotMap extends never ? string : keyof VersionedSlotMap;
+type DiscriminatedSlotMap = {
+    [K in keyof VersionedSlotMap]: {
+        [V in keyof VersionedSlotMap[K]]: Intersection<VersionedSlotMap[K][V], {_component: string | null}>
+    }
+};
+
+type UnionContent = {
+    [K in ComponentVersionId]: Intersection<ComponentContent<K>, {_component: K}>;
+};
+
+type UnknownContent = UnionContent[ComponentVersionId] extends never
+    ? (JsonObject & {_component: string | null})
+    : UnionContent[ComponentVersionId];
 
-export type SlotVersion<I extends SlotId = SlotId> = LatestAlias | (
-    I extends keyof VersionedSlotMap
-        ? keyof VersionedSlotMap[I]
-        : never
-);
+type VersionedContent<I extends VersionedSlotId> = Versioned<I, DiscriminatedSlotMap, UnknownContent>;
+
+export type DynamicSlotId = any;
+
+export type SlotId = keyof VersionedSlotMap extends never ? string : keyof VersionedSlotMap;
 
-export type VersionedSlotId<I extends SlotId = SlotId> = I | {[K in SlotId]: `${K}@${SlotVersion<K> & string}`}[I];
+export type SlotVersion<I extends SlotId = SlotId> = Version<VersionedSlotMap, I>;
 
-type VersionedSlotContent<I extends SlotId, V extends string = LatestAlias, C extends JsonObject = JsonObject> =
-    I extends keyof VersionedSlotMap
-        ? (V extends keyof VersionedSlotMap[I]
-            ? VersionedSlotMap[I][V]
-            : C)
-        : C;
+export type SlotVersionId<I extends SlotId = SlotId> = CanonicalVersionId<I, VersionedSlotMap>;
 
-export type ExtractSlotVersion<I extends string> = I extends `${string}@${infer V}`
-    ? (LatestAlias extends V ? LatestAlias : (V extends `${number}` ? V : never))
-    : LatestAlias;
+export type VersionedSlotId<I extends SlotId = SlotId> = VersionedId<I, VersionedSlotMap>;
 
-export type ExtractSlotId<I extends string> = I extends `${infer V}@${string}` ? V : I;
+export type CompatibleSlotContent<T extends ComponentVersionId = ComponentVersionId> = UnionContent[T];
 
-export type SlotContent<I extends VersionedSlotId, C extends JsonObject = JsonObject> =
-    VersionedSlotContent<ExtractSlotId<I>, ExtractSlotVersion<I>, C>;
+export type SlotContent<I extends VersionedSlotId = VersionedSlotId, C extends JsonObject = JsonObject> =
+    JsonObject extends C ? (string extends I ? UnknownContent : VersionedContent<I>) : C;

package/src/versioning.ts

@@ -0,0 +1,29 @@
+import {JsonObject} from '@croct/json';
+
+export type LatestAlias = 'latest';
+
+export type ExtractVersion<I extends string> = I extends `${string}@${infer V}`
+    ? (LatestAlias extends V ? LatestAlias : (V extends `${number}` ? V : never))
+    : LatestAlias;
+
+export type CanonicalVersionId<I extends string, M> = {
+    [K in I]: `${K}@${Extract<Version<M, K>, `${number}`>}`
+}[I];
+
+/**
+ * Utility type that coerces any type to a string if it is not a string literal.
+ */
+type CastString<T extends string> = T extends `${infer V}` ? V : string;
+
+export type VersionedId<I extends string, M> = CastString<I> | {[K in I]: `${K}@${Version<M, K> & string}`}[I];
+
+export type ExtractId<I extends string> = I extends `${infer V}@${string}` ? V : CastString<I>;
+
+export type Version<M, I extends string> = LatestAlias | (I extends keyof M ? keyof M[I] : never);
+
+export type Versioned<I extends string, M, C extends JsonObject = JsonObject> =
+    ExtractId<I> extends keyof M
+        ? ExtractVersion<I> extends keyof M[ExtractId<I>]
+            ? M[ExtractId<I>][ExtractVersion<I>]
+            : C
+        : C;

package/versioning.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject } from '@croct/json';
+export type LatestAlias = 'latest';
+export type ExtractVersion<I extends string> = I extends `${string}@${infer V}` ? (LatestAlias extends V ? LatestAlias : (V extends `${number}` ? V : never)) : LatestAlias;
+export type CanonicalVersionId<I extends string, M> = {
+    [K in I]: `${K}@${Extract<Version<M, K>, `${number}`>}`;
+}[I];
+/**
+ * Utility type that coerces any type to a string if it is not a string literal.
+ */
+type CastString<T extends string> = T extends `${infer V}` ? V : string;
+export type VersionedId<I extends string, M> = CastString<I> | {
+    [K in I]: `${K}@${Version<M, K> & string}`;
+}[I];
+export type ExtractId<I extends string> = I extends `${infer V}@${string}` ? V : CastString<I>;
+export type Version<M, I extends string> = LatestAlias | (I extends keyof M ? keyof M[I] : never);
+export type Versioned<I extends string, M, C extends JsonObject = JsonObject> = ExtractId<I> extends keyof M ? ExtractVersion<I> extends keyof M[ExtractId<I>] ? M[ExtractId<I>][ExtractVersion<I>] : C : C;
+export {};

package/versioning.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=versioning.js.map

package/versioning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versioning.js","sourceRoot":"","sources":["src/versioning.ts"],"names":[],"mappings":""}