@kosdev-code/kos-ddk-models 0.1.0-dev.61 → 0.1.0-dev.63

package/lib/mock/ddk-mock.d.ts

@@ -0,0 +1,60 @@
+import { NavigationItem } from '../application/services';
+import { DdkNcuiDescriptor, DdkSetupStepEntry, DdkUtilityEntry } from './ncui-mock-data';
+export interface DdkMockHelpers {
+    /**
+     * Serves a descriptor project's `kondra.ncui` as the installed NCUI descriptor,
+     * and lists its setup steps in its order (keeping each step's state from the
+     * backend). Takes the descriptor project's `.kos.json`, or its `kondra.ncui`.
+     */
+    useDescriptor(descriptor: {
+        kondra: {
+            ncui: DdkNcuiDescriptor;
+        };
+    } | DdkNcuiDescriptor): () => void;
+    /** Adds a utility to a column of the utilities screen (default: the last). */
+    addUtility(entry: DdkUtilityEntry, options?: {
+        column?: number;
+    }): () => void;
+    /**
+     * Adds a navigation view under the navigation at `parent` (a path such as
+     * `settings`), or at the top level.
+     */
+    addNavigation(entry: NavigationItem, options?: {
+        parent?: string;
+    }): () => void;
+    /** Adds a setup step after the others (or before the step named `before`). */
+    addSetupStep(entry: DdkSetupStepEntry, options?: {
+        before?: string;
+    }): () => void;
+}
+interface MockRequest {
+    path: string;
+}
+type ResponseTransformer = (body: unknown) => unknown;
+/** The part of the SDK's KosMock (`window.KosMock`) these helpers use. */
+export interface DdkKosMock {
+    get(pattern: string, handler: (req: MockRequest) => {
+        data?: unknown;
+    }, options?: {
+        id?: string;
+        description?: string;
+        when?: (req: MockRequest) => boolean;
+    }): {
+        remove(): void;
+    };
+    transformResponse(method: string, pattern: string, transform: ResponseTransformer, options?: {
+        description?: string;
+    }): {
+        remove(): void;
+    };
+    /** SDK API level 27. */
+    extend?(name: string, factory: (kosMock: DdkKosMock) => DdkMockHelpers): () => void;
+}
+export declare const createDdkMockHelpers: (kosMock: DdkKosMock) => DdkMockHelpers;
+/**
+ * Adds `kosMock.ddk` for setup modules. A no-op without KosMock or on an SDK
+ * without `KosMock.extend`.
+ */
+export declare const registerDdkMock: () => void;
+export {};
+//# sourceMappingURL=ddk-mock.d.ts.map

package/lib/mock/ddk-mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ddk-mock.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/mock/ddk-mock.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EAML,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAS1B,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE;QAAE,MAAM,EAAE;YAAE,IAAI,EAAE,iBAAiB,CAAA;SAAE,CAAA;KAAE,GAAG,iBAAiB,GACtE,MAAM,IAAI,CAAC;IACd,8EAA8E;IAC9E,UAAU,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,IAAI,CAAC;IAC9E;;;OAGG;IACH,aAAa,CACX,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5B,MAAM,IAAI,CAAC;IACd,8EAA8E;IAC9E,YAAY,CACV,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAC5B,MAAM,IAAI,CAAC;CACf;AAED,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,KAAK,mBAAmB,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;AAEtD,0EAA0E;AAC1E,MAAM,WAAW,UAAU;IACzB,GAAG,CACD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,EACjD,OAAO,CAAC,EAAE;QACR,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,OAAO,CAAC;KACtC,GACA;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,CAAC;IACtB,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,mBAAmB,EAC9B,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GACjC;QAAE,MAAM,IAAI,IAAI,CAAA;KAAE,CAAC;IACtB,wBAAwB;IACxB,MAAM,CAAC,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,cAAc,GAC/C,MAAM,IAAI,CAAC;CACf;AAeD,eAAO,MAAM,oBAAoB,GAAI,SAAS,UAAU,KAAG,cAiF1D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,YAQ3B,CAAC"}

package/lib/mock/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ddk-mock';
+export * from './ncui-mock-data';
+//# sourceMappingURL=index.d.ts.map

package/lib/mock/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/mock/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/lib/mock/ncui-mock-data.d.ts

@@ -0,0 +1,29 @@
+import { NavigationItem } from '../application/services';
+import { SetupStepResponse } from '../setup-step/services';
+export interface DdkUtilityEntry {
+    name: string;
+    options?: Record<string, unknown>;
+    roles?: string[];
+}
+export interface DdkSetupStepEntry {
+    name: string;
+    preStep?: boolean;
+    exclusive?: boolean;
+}
+/** The `kondra.ncui` sections of an NCUI descriptor. */
+export interface DdkNcuiDescriptor {
+    setup?: {
+        steps?: DdkSetupStepEntry[];
+    };
+    utilities?: DdkUtilityEntry[][];
+    navigations?: NavigationItem[];
+    [section: string]: unknown;
+}
+/** The value at a dotted path such as `kondra.ncui.utilities`, or undefined. */
+export declare const descriptorValue: (ncui: DdkNcuiDescriptor, path: string) => unknown;
+/** The descriptor's steps, in its order, each keeping the backend's state. */
+export declare const descriptorSetupSteps: (steps: DdkSetupStepEntry[], backend: SetupStepResponse[]) => SetupStepResponse[];
+export declare const withUtility: (columns: DdkUtilityEntry[][], entry: DdkUtilityEntry, column?: number) => DdkUtilityEntry[][];
+export declare const withNavigation: (items: NavigationItem[], entry: NavigationItem, parent?: string) => NavigationItem[];
+export declare const withSetupStep: (steps: SetupStepResponse[], entry: DdkSetupStepEntry, before?: string) => SetupStepResponse[];
+//# sourceMappingURL=ncui-mock-data.d.ts.map

package/lib/mock/ncui-mock-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ncui-mock-data.d.ts","sourceRoot":"","sources":["../../../../../packages/kos-ddk-models/src/lib/mock/ncui-mock-data.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;KAAE,CAAC;IACxC,SAAS,CAAC,EAAE,eAAe,EAAE,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;IAC/B,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,gFAAgF;AAChF,eAAO,MAAM,eAAe,GAC1B,MAAM,iBAAiB,EACvB,MAAM,MAAM,KACX,OASE,CAAC;AAEN,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,GAC/B,OAAO,iBAAiB,EAAE,EAC1B,SAAS,iBAAiB,EAAE,KAC3B,iBAAiB,EAOf,CAAC;AAEN,eAAO,MAAM,WAAW,GACtB,SAAS,eAAe,EAAE,EAAE,EAC5B,OAAO,eAAe,EACtB,eAA2B,KAC1B,eAAe,EAAE,EAGuD,CAAC;AAE5E,eAAO,MAAM,cAAc,GACzB,OAAO,cAAc,EAAE,EACvB,OAAO,cAAc,EACrB,SAAS,MAAM,KACd,cAAc,EAehB,CAAC;AAEF,eAAO,MAAM,aAAa,GACxB,OAAO,iBAAiB,EAAE,EAC1B,OAAO,iBAAiB,EACxB,SAAS,MAAM,KACd,iBAAiB,EAMnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kosdev-code/kos-ddk-models",
-  "version": "0.1.0-dev.61",
+  "version": "0.1.0-dev.63",
   "dependencies": {
     "@kosdev-code/kos-ui-sdk": "~3.0.0",
     "@kosdev-code/kos-dispense-sdk": "~3.0.0",
@@ -12,7 +12,7 @@
   "typings": "./index.d.ts",
   "kos": {
     "build": {
-      "gitHash": "edc581166b672e67c4ae900dff675c78908691b1"
+      "gitHash": "bc5245dbcb317a31a44c3441ff772db881239b65"
     }
   },
   "publishConfig": {