@myop/sdk 0.4.0-beta.4 → 0.4.0-beta.6

package/dist/module/helpers/cloudRepositoryHelpers.d.ts

@@ -32,21 +32,28 @@ export declare const enableSelfHosted: (cdnUrl: string, queryParams?: Record<str
  *     inside the freshness the server promised, is rendered with NO request. Once the
  *     window ends the browser sends back the version it holds instead of re-downloading.
  *   - A preview is never minified and never cached.
- *   - Only /consume moves. Everything else keeps the host it has today.
+ *   - Only /consume moves. Everything else keeps the host it has today -- unless
+ *     `flow: true`, which also moves v1 component configs (`/flow?auto=true`), with the
+ *     same fallback.
  *   - Asking for `minify` does not force it: the server decides per component, and a
  *     component that is not enabled is served raw, which is not an error.
  *
  * `host` is for us (a staging lane, a local server); leave it out.
+ *
+ * @internal Delivery lane: kept out of the public API reference until it is released.
  */
 export declare const DELIVERY_HOST = "https://delivery.myop.dev";
+/** @internal */
 export declare const delivery: (opts?: {
     minify?: boolean;
     cache?: boolean;
+    flow?: boolean;
     host?: string | null;
 }) => {
     host: string;
     minify: boolean;
     cache: boolean;
+    flow: boolean;
     requests: number;
     viaDelivery: number;
     fellBack: number;
@@ -62,11 +69,14 @@ export declare const delivery: (opts?: {
  * Forget what this browser holds, so the next load asks the server. Use it when a change
  * has to be visible on THIS load — right after someone publishes — rather than within the
  * freshness window.
+ *
+ * @internal
  */
 export declare const deliveryRefresh: () => Promise<{
     host: string;
     minify: boolean;
     cache: boolean;
+    flow: boolean;
     requests: number;
     viaDelivery: number;
     fellBack: number;
@@ -81,11 +91,14 @@ export declare const deliveryRefresh: () => Promise<{
 /**
  * What answered the last requests, and — the number worth watching — how many times the
  * SDK had to fall back to the default host because the lane did not answer.
+ *
+ * @internal
  */
 export declare const deliveryStats: () => {
     host: string;
     minify: boolean;
     cache: boolean;
+    flow: boolean;
     requests: number;
     viaDelivery: number;
     fellBack: number;
@@ -97,11 +110,12 @@ export declare const deliveryStats: () => {
     unchanged: number;
     bytesSaved: number;
 };
-/** Undo delivery(): back to the default host and raw bytes, with no reload. */
+/** Undo delivery(): back to the default host and raw bytes, with no reload. @internal */
 export declare const deliveryOff: () => {
     host: string;
     minify: boolean;
     cache: boolean;
+    flow: boolean;
     requests: number;
     viaDelivery: number;
     fellBack: number;
@@ -116,6 +130,16 @@ export declare const deliveryOff: () => {
 export declare const setCloudRepository: (repository: CloudRepository) => void;
 export declare const setEnvironment: (env: string) => void;
 export declare const getResolvedConfig: (componentId: string, env?: string, preview?: boolean) => IComponentConfig;
+/**
+ * The runtime tags of a loaded/preloaded component: only tags named `ui:...` (e.g.
+ * `ui:beta`). Returns `[]` when it has none or has not been fetched yet.
+ *
+ * ```ts
+ * await preloadComponents([id]);
+ * getComponentTags(id); // ['ui:beta']
+ * ```
+ */
+export declare const getComponentTags: (componentId: string, env?: string, preview?: boolean) => string[];
 export declare const preloadComponents: (ids: string[], env?: string, preview?: boolean) => Promise<PromiseSettledResult<IComponentConfig>[]>;
 /**
  * Seed already-resolved component configs into the SDK cache, with no network
@@ -135,3 +159,19 @@ export declare const preloadComponents: (ids: string[], env?: string, preview?:
  * match what a plain `preloadComponents([id])` would have used.
  */
 export declare const hydrateComponents: (configs: Record<string, IComponentConfig>, env?: string, preview?: boolean) => void;
+/**
+ * The v1 (iframe component) counterpart of {@link hydrateComponents}: seed configs that a
+ * server already fetched, so `loadComponent` needs no `/flow` request at all.
+ *
+ * ```ts
+ * // server (cache it ~60 s; `prefetch=1` keeps this fetch out of the view count, `for` says which
+ * // page it is for, so the prefetch is attributed to your site — its query string is not stored):
+ * const flow = await (await fetch(`https://cloud.myop.dev/flow?id=${id}&auto=true&prefetch=1&for=${encodeURIComponent(pageUrl)}`)).json();
+ * // embed JSON.stringify(flow) in the page, then on the client:
+ * hydrateV1Components({ [id]: flow });
+ * const cfg = await CloudRepository.Main.fetchComponentV1(id);   // no request
+ * ```
+ *
+ * Each seeded config is counted as a view the first time it is used (via /clientUsage).
+ */
+export declare const hydrateV1Components: (flows: Record<string, any>) => void;