@kosdev-code/kos-ui-sdk 3.0.20 → 3.0.22

package/testing.js

@@ -0,0 +1,80 @@
+import "mobx";
+import { l as KosCore, b0 as KosMock, al as RegistrationManager } from "./index-YzHb2lnB.js";
+import "loglevel";
+let booted;
+let prepared = false;
+function prepareTransport(alias) {
+  if (prepared) {
+    return;
+  }
+  prepared = true;
+  KosMock.configure({ standalone: true });
+  KosCore.getInstance({ connectionAlias: alias });
+}
+function bootCore(registration, options) {
+  if (!booted) {
+    prepareTransport(options.alias);
+    const core = KosCore.create(registration, false, options.alias);
+    booted = core.whenReady().then(() => core);
+  }
+  return booted;
+}
+function buildBootBuilder() {
+  const registrations = [];
+  const preloadModels = [];
+  let alias;
+  const builder = {
+    model: (registration, preload) => {
+      registrations.push(
+        () => RegistrationManager.model.register(builder)(registration, preload)
+      );
+      return builder;
+    },
+    preload: (model) => {
+      preloadModels.push(model);
+      return builder;
+    },
+    companion: (parentType, companion) => {
+      registrations.push(
+        () => RegistrationManager.companion.register(builder)(parentType, companion)
+      );
+      return builder;
+    },
+    legacy: (type, registration) => {
+      registrations.push(
+        () => RegistrationManager.model.registerLegacyModel(builder)(
+          type,
+          registration
+        )
+      );
+      return builder;
+    },
+    alias: (value) => {
+      alias = value;
+      return builder;
+    },
+    boot: () => {
+      prepareTransport(alias);
+      registrations.splice(0).forEach((register) => register());
+      return bootCore({ models: {}, preloadModels }, { alias });
+    }
+  };
+  return builder;
+}
+function bootKosCore(registration, options = {}) {
+  return registration ? bootCore(registration, options) : buildBootBuilder();
+}
+async function until(predicate, label, timeoutMs = 2e3) {
+  const deadline = Date.now() + timeoutMs;
+  while (!predicate()) {
+    if (Date.now() > deadline) {
+      throw new Error(`timed out waiting for ${label}`);
+    }
+    await new Promise((resolve) => setTimeout(resolve, 5));
+  }
+}
+export {
+  bootKosCore,
+  until
+};
+//# sourceMappingURL=testing.js.map

package/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sources":["../../../packages/kos-ui-sdk/src/testing/index.ts"],"sourcesContent":["/**\n * Test support for KOS models — boot the framework in a unit test, with no\n * device, no WebSocket server and no browser.\n *\n * KOS models cannot be built in isolation: they need a live KosCore, and\n * KosCore opens a WebSocket the moment it is created. `bootKosCore` boots it on\n * KosMock's standalone loopback transport instead, which authorizes itself so\n * `whenReady()` resolves with no device and no `KOS_ALLOW_ANONYMOUS` build flag.\n *\n * Models register the way an application registers them. `bootKosCore()` with\n * no arguments returns a builder carrying the same chain an app's\n * `KosModelRegistry` gives — `.model()`, `.preload()`, `.companion()`,\n * `.legacy()` — so a test hands over the registration bean itself rather than\n * assembling a registry by hand.\n *\n * Backend traffic is mocked the same way an app would mock it — `KosMock.get`,\n * `KosMock.post`, fixtures, config injection — so a test exercises the real\n * request path rather than a stubbed service function.\n *\n * ```ts\n * import { bootKosCore, until } from \"@kosdev-code/kos-ui-sdk/testing\";\n * import { KosMock } from \"@kosdev-code/kos-ui-sdk\";\n * import { Board } from \"./models/board\";\n *\n * beforeAll(async () => {\n *   KosMock.get(\"/api/board/:id\", { data: { id: \"b1\", state: \"READY\" } });\n *   await bootKosCore().model(Board).boot();\n * });\n *\n * it(\"loads the board\", async () => {\n *   const board = Board.instance(\"b1\").options({}).build();\n *   await whenReady(board);\n *   expect(board.state).toBe(\"READY\");\n * });\n * ```\n *\n * ## Two things that bite\n *\n * **Singleton models take one configuration per test file.** A second\n * `options(...)` call returns the FIRST instance and discards the new options in\n * silence, so assertions written against them pass for the wrong reason. A case\n * needing different options belongs in its own file, which the test runner\n * gives its own module state.\n *\n * **The standalone socket authorizes by publishing Studio's\n * `/studioServer/auth/LOGGED_IN` on every open.** A device never sends that, so\n * a test shaped around disconnect/reconnect here is exercising Studio's\n * sequence, not a device's. It makes no difference to tests that never\n * reconnect.\n */\nimport type {\n  BaseKosModelRegistrationBean,\n  IKosCoreManager,\n  IKosModelRegistration,\n  IKosRegistry,\n  KosCompanionModelType,\n  KosModelRegistrationType,\n  Preloaded,\n} from \"../core\";\nimport { KosCore, KosMock, RegistrationManager } from \"../core\";\n\nlet booted: Promise<IKosCoreManager> | undefined;\nlet prepared = false;\n\nexport interface BootKosCoreOptions {\n  /** Connection alias, when the model under test cares about one. */\n  alias?: string;\n}\n\n/**\n * A model's registration bean — the value `@kosModel` generates beside the\n * model, and the one an application passes to `KosModelRegistry...model()`.\n *\n * The bean itself, not its `registration` property: handing over the property\n * registers nothing, and the model only fails later, on the first build.\n */\nexport type KosTestRegistration =\n  | BaseKosModelRegistrationBean<any, any>\n  | KosModelRegistrationType<any, any>;\n\n/**\n * The registration chain an application uses, terminated by `boot()`.\n *\n * Every call is deferred until `boot()`, so ordering within the chain does not\n * matter and `alias()` may come after the models it applies to.\n */\nexport interface KosCoreBootBuilder {\n  /** Register a model under test, optionally preloading it. */\n  model: (\n    registration: KosTestRegistration,\n    preload?: boolean\n  ) => KosCoreBootBuilder;\n  /** Preload a model type, or a specific instance of one, at boot. */\n  preload: (model: Preloaded) => KosCoreBootBuilder;\n  /** Attach a companion model type to a parent type. */\n  companion: (\n    parentType: string,\n    companion: KosCompanionModelType<any>\n  ) => KosCoreBootBuilder;\n  /** Register a hand-written registration record against a type. */\n  legacy: (\n    type: string,\n    registration: IKosModelRegistration\n  ) => KosCoreBootBuilder;\n  /** Connection alias, when the model under test cares about one. */\n  alias: (alias: string) => KosCoreBootBuilder;\n  /** Boot KosCore with everything registered on this chain. */\n  boot: () => Promise<IKosCoreManager>;\n}\n\n/**\n * Put the mock transport and the connection alias in place before anything\n * constructs KosCore.\n *\n * KosCore picks its transport and reads its alias in the constructor, and\n * registering a model reaches `KosCore.getInstance()` — so registration cannot\n * come first.\n */\nfunction prepareTransport(alias?: string): void {\n  if (prepared) {\n    return;\n  }\n  prepared = true;\n  KosMock.configure({ standalone: true });\n  KosCore.getInstance({ connectionAlias: alias });\n}\n\nfunction bootCore(\n  registration: IKosRegistry,\n  options: BootKosCoreOptions\n): Promise<IKosCoreManager> {\n  if (!booted) {\n    prepareTransport(options.alias);\n    const core = KosCore.create(registration, false, options.alias);\n    booted = core.whenReady().then(() => core);\n  }\n  return booted;\n}\n\nfunction buildBootBuilder(): KosCoreBootBuilder {\n  const registrations: (() => void)[] = [];\n  const preloadModels: Preloaded[] = [];\n  let alias: string | undefined;\n\n  const builder: KosCoreBootBuilder = {\n    model: (registration, preload) => {\n      registrations.push(() =>\n        RegistrationManager.model.register(builder)(registration, preload)\n      );\n      return builder;\n    },\n    preload: (model) => {\n      preloadModels.push(model);\n      return builder;\n    },\n    companion: (parentType, companion) => {\n      registrations.push(() =>\n        RegistrationManager.companion.register(builder)(parentType, companion)\n      );\n      return builder;\n    },\n    legacy: (type, registration) => {\n      registrations.push(() =>\n        RegistrationManager.model.registerLegacyModel(builder)(\n          type,\n          registration\n        )\n      );\n      return builder;\n    },\n    alias: (value) => {\n      alias = value;\n      return builder;\n    },\n    boot: () => {\n      prepareTransport(alias);\n      registrations.splice(0).forEach((register) => register());\n      return bootCore({ models: {}, preloadModels }, { alias });\n    },\n  };\n\n  return builder;\n}\n\n/**\n * Open a registration chain, then `boot()` it.\n *\n * Idempotent per module instance: the first `boot()` boots, later ones return\n * the same core. KosCore and the model manager are process-global, so a test\n * file gets one core and one set of singletons — which is the isolation\n * boundary, and the reason a differently-configured singleton needs its own\n * file.\n *\n * Register any routes the models need BEFORE calling `boot()`, so nothing races\n * the boot requests.\n *\n * @example\n * ```ts\n * await bootKosCore().model(AssetManager).model(AssetEntry).boot();\n * ```\n */\nexport function bootKosCore(): KosCoreBootBuilder;\n/**\n * Boot KosCore from an assembled registry.\n *\n * Kept for callers that already hold an `IKosRegistry`. A test registering its\n * own models should use the no-argument chain instead, which takes the\n * registration beans directly.\n *\n * @param registration Models under test, e.g. `{ models: {...}, preloadModels: [] }`.\n */\nexport function bootKosCore(\n  registration: IKosRegistry,\n  options?: BootKosCoreOptions\n): Promise<IKosCoreManager>;\nexport function bootKosCore(\n  registration?: IKosRegistry,\n  options: BootKosCoreOptions = {}\n): KosCoreBootBuilder | Promise<IKosCoreManager> {\n  return registration ? bootCore(registration, options) : buildBootBuilder();\n}\n\n/**\n * Wait until `predicate` holds, then resolve — or reject naming what never\n * happened.\n *\n * Model reactions are asynchronous, so a test that changes an input and asserts\n * immediately reads the old value. Polling for the OUTCOME beats sleeping for an\n * arbitrary interval: it is faster when the reaction is quick, and it fails with\n * a usable message instead of a bare assertion diff when the reaction never\n * fires at all.\n *\n * @param label What is being waited for, quoted back in the timeout message.\n */\nexport async function until(\n  predicate: () => boolean,\n  label: string,\n  timeoutMs = 2000\n): Promise<void> {\n  const deadline = Date.now() + timeoutMs;\n  while (!predicate()) {\n    if (Date.now() > deadline) {\n      throw new Error(`timed out waiting for ${label}`);\n    }\n    await new Promise((resolve) => setTimeout(resolve, 5));\n  }\n}\n"],"names":[],"mappings":";;;AA6DA,IAAI;AACJ,IAAI,WAAW;AAwDf,SAAS,iBAAiB,OAAsB;AAC9C,MAAI,UAAU;AACZ;AAAA,EACF;AACA,aAAW;AACX,UAAQ,UAAU,EAAE,YAAY,KAAA,CAAM;AACtC,UAAQ,YAAY,EAAE,iBAAiB,MAAA,CAAO;AAChD;AAEA,SAAS,SACP,cACA,SAC0B;AAC1B,MAAI,CAAC,QAAQ;AACX,qBAAiB,QAAQ,KAAK;AAC9B,UAAM,OAAO,QAAQ,OAAO,cAAc,OAAO,QAAQ,KAAK;AAC9D,aAAS,KAAK,UAAA,EAAY,KAAK,MAAM,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAEA,SAAS,mBAAuC;AAC9C,QAAM,gBAAgC,CAAA;AACtC,QAAM,gBAA6B,CAAA;AACnC,MAAI;AAEJ,QAAM,UAA8B;AAAA,IAClC,OAAO,CAAC,cAAc,YAAY;AAChC,oBAAc;AAAA,QAAK,MACjB,oBAAoB,MAAM,SAAS,OAAO,EAAE,cAAc,OAAO;AAAA,MAAA;AAEnE,aAAO;AAAA,IACT;AAAA,IACA,SAAS,CAAC,UAAU;AAClB,oBAAc,KAAK,KAAK;AACxB,aAAO;AAAA,IACT;AAAA,IACA,WAAW,CAAC,YAAY,cAAc;AACpC,oBAAc;AAAA,QAAK,MACjB,oBAAoB,UAAU,SAAS,OAAO,EAAE,YAAY,SAAS;AAAA,MAAA;AAEvE,aAAO;AAAA,IACT;AAAA,IACA,QAAQ,CAAC,MAAM,iBAAiB;AAC9B,oBAAc;AAAA,QAAK,MACjB,oBAAoB,MAAM,oBAAoB,OAAO;AAAA,UACnD;AAAA,UACA;AAAA,QAAA;AAAA,MACF;AAEF,aAAO;AAAA,IACT;AAAA,IACA,OAAO,CAAC,UAAU;AAChB,cAAQ;AACR,aAAO;AAAA,IACT;AAAA,IACA,MAAM,MAAM;AACV,uBAAiB,KAAK;AACtB,oBAAc,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,UAAU;AACxD,aAAO,SAAS,EAAE,QAAQ,CAAA,GAAI,cAAA,GAAiB,EAAE,OAAO;AAAA,IAC1D;AAAA,EAAA;AAGF,SAAO;AACT;AAiCO,SAAS,YACd,cACA,UAA8B,IACiB;AAC/C,SAAO,eAAe,SAAS,cAAc,OAAO,IAAI,iBAAA;AAC1D;AAcA,eAAsB,MACpB,WACA,OACA,YAAY,KACG;AACf,QAAM,WAAW,KAAK,IAAA,IAAQ;AAC9B,SAAO,CAAC,aAAa;AACnB,QAAI,KAAK,IAAA,IAAQ,UAAU;AACzB,YAAM,IAAI,MAAM,yBAAyB,KAAK,EAAE;AAAA,IAClD;AACA,UAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,CAAC,CAAC;AAAA,EACvD;AACF;"}

package/ui/contexts/translation-container/kos-translations-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kos-translations-provider.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/ui/contexts/translation-container/kos-translations-provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,EACZ,yBAAyB,EAE1B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,iBAAiB,EAMlB,MAAM,OAAO,CAAC;AAEf,UAAU,wBAAwB;IAChC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACjD;AACD,eAAO,MAAM,2BAA2B,+DAE5B,CAAC;AAEb,UAAU,iCAAiC;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IACjD,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,CACT,IAAI,EAAE,yBAAyB,EAC/B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,KACX,MAAM,CAAC;CACb;AAUD,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,iBAAiB,CAC1D,iBAAiB,CAAC,iCAAiC,CAAC,CA2HrD,CAAC;AACF,eAAO,MAAM,wBAAwB,gCAQpC,CAAC"}
+{"version":3,"file":"kos-translations-provider.d.ts","sourceRoot":"","sources":["../../../../../../packages/kos-ui-sdk/src/ui/contexts/translation-container/kos-translations-provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,YAAY,EACZ,yBAAyB,EAI1B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,iBAAiB,EAMlB,MAAM,OAAO,CAAC;AAEf,UAAU,wBAAwB;IAChC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACjD;AACD,eAAO,MAAM,2BAA2B,+DAE5B,CAAC;AAEb,UAAU,iCAAiC;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IACjD,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,CACT,IAAI,EAAE,yBAAyB,EAC/B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,KACX,MAAM,CAAC;CACb;AAUD,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,iBAAiB,CAC1D,iBAAiB,CAAC,iCAAiC,CAAC,CAyFrD,CAAC;AACF,eAAO,MAAM,wBAAwB,gCAQpC,CAAC"}