@posiwise/shared-components 0.0.219 → 0.0.220
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -2250,15 +2250,23 @@ export declare class RecordsSummaryComponent {
|
|
|
2250
2250
|
}
|
|
2251
2251
|
/**
|
|
2252
2252
|
* The onboarding status every product API returns from its `onboarding_status` tool and
|
|
2253
|
-
* `GET onboarding/:subscription_id/status` endpoint (cloudolive-api#441). Product-agnostic:
|
|
2254
|
-
*
|
|
2253
|
+
* `GET onboarding/:subscription_id/status` endpoint (cloudolive-api#441). Product-agnostic: step titles and
|
|
2254
|
+
* descriptions are the text the product's master subscription admin wrote; blocked reasons and states arrive
|
|
2255
|
+
* as Transloco keys owned by the product.
|
|
2255
2256
|
*/
|
|
2256
2257
|
export type OnboardingStepState = 'done' | 'next' | 'ready' | 'blocked' | 'waiting' | 'todo' | 'optional' | 'unknown';
|
|
2257
2258
|
export interface OnboardingStep {
|
|
2258
2259
|
key: string;
|
|
2259
2260
|
position: number;
|
|
2260
2261
|
kind: 'required' | 'optional' | 'system';
|
|
2261
|
-
|
|
2262
|
+
/** The step's title as the admin wrote it. */
|
|
2263
|
+
title?: string;
|
|
2264
|
+
description?: string | null;
|
|
2265
|
+
/** The product's check that decides the step; null = manual, the customer ticks it. */
|
|
2266
|
+
check_key?: string | null;
|
|
2267
|
+
/** @deprecated Transloco key from before steps became editable; use `title`. */
|
|
2268
|
+
title_key?: string;
|
|
2269
|
+
/** @deprecated Use `description`. */
|
|
2262
2270
|
description_key?: string | null;
|
|
2263
2271
|
route?: string | null;
|
|
2264
2272
|
/** Slug of the FAQ that explains the step; null when the product API found no FAQ the viewer can open. */
|
|
@@ -2306,7 +2314,14 @@ export declare class OnboardingChecklistComponent implements OnChanges {
|
|
|
2306
2314
|
/** Values for the `{slug}` / `{subscription_id}` placeholders in step routes. */
|
|
2307
2315
|
slug: string;
|
|
2308
2316
|
subscriptionId: number | null;
|
|
2317
|
+
/** The host is saving a manual tick: the tick controls are disabled meanwhile. */
|
|
2318
|
+
busy: boolean;
|
|
2309
2319
|
readonly retry: EventEmitter<void>;
|
|
2320
|
+
/** A manual step was ticked (completed: true) or unticked; the host saves it and passes the new status. */
|
|
2321
|
+
readonly markDone: EventEmitter<{
|
|
2322
|
+
key: string;
|
|
2323
|
+
completed: boolean;
|
|
2324
|
+
}>;
|
|
2310
2325
|
readonly doneIcon: IconDefinition;
|
|
2311
2326
|
readonly helpIcon: IconDefinition;
|
|
2312
2327
|
readonly expandIcon: IconDefinition;
|
|
@@ -2319,10 +2334,6 @@ export declare class OnboardingChecklistComponent implements OnChanges {
|
|
|
2319
2334
|
expanded: boolean;
|
|
2320
2335
|
ngOnChanges(changes: SimpleChanges): void;
|
|
2321
2336
|
toggle(): void;
|
|
2322
|
-
private static storageKey;
|
|
2323
|
-
/** true / false once the user has toggled; null when they never did or storage is unavailable. */
|
|
2324
|
-
private static readCollapsed;
|
|
2325
|
-
private static writeCollapsed;
|
|
2326
2337
|
get visible(): boolean;
|
|
2327
2338
|
/** Recommended steps, done and total, shown next to the mandatory progress ("+ 1 of 3 recommended"). */
|
|
2328
2339
|
get recommended(): {
|
|
@@ -2331,7 +2342,6 @@ export declare class OnboardingChecklistComponent implements OnChanges {
|
|
|
2331
2342
|
};
|
|
2332
2343
|
/** One segment per mandatory step, so the bar reads as "steps done", not an abstract percentage. */
|
|
2333
2344
|
get progressSegments(): number[];
|
|
2334
|
-
get progressPercent(): number;
|
|
2335
2345
|
/**
|
|
2336
2346
|
* Every required step is done. Deliberately NOT `status.activated`: activation is the product's
|
|
2337
2347
|
* milestone (e.g. a first finalised reconciliation) and can be reached with required steps still
|
|
@@ -2352,14 +2362,16 @@ export declare class OnboardingChecklistComponent implements OnChanges {
|
|
|
2352
2362
|
get currentStep(): OnboardingStep | null;
|
|
2353
2363
|
icon(step: OnboardingStep): IconDefinition;
|
|
2354
2364
|
routeFor(step: OnboardingStep): string | null;
|
|
2355
|
-
/**
|
|
2356
|
-
* /{subscription slug}/faq/{faq slug} — the app's FAQ route (`:slug/faq/:id`), the same link the
|
|
2357
|
-
* products' own help links use. Null when the step has no FAQ to open.
|
|
2358
|
-
*/
|
|
2365
|
+
/** /{subscription slug}/faq/{faq slug} (the app's `:slug/faq/:id` route); null when there is no FAQ. */
|
|
2359
2366
|
faqHref(step: OnboardingStep): string | null;
|
|
2360
2367
|
/** A step's call to action; null when there is nothing for this viewer to click. */
|
|
2361
2368
|
actionKey(step: OnboardingStep): string | null;
|
|
2362
|
-
|
|
2369
|
+
/**
|
|
2370
|
+
* A manual step the viewer can tick: no check decides it (check_key null), its state is known, and the
|
|
2371
|
+
* viewer may act on it (an admin-only step needs an admin).
|
|
2372
|
+
*/
|
|
2373
|
+
canTick(step: OnboardingStep): boolean;
|
|
2374
|
+
tick(step: OnboardingStep): void;
|
|
2363
2375
|
static ɵfac: i0.ɵɵFactoryDeclaration<OnboardingChecklistComponent, never>;
|
|
2364
2376
|
static ɵcmp: i0.ɵɵComponentDeclaration<OnboardingChecklistComponent, "pw-onboarding-checklist", never, {
|
|
2365
2377
|
"status": {
|
|
@@ -2382,8 +2394,13 @@ export declare class OnboardingChecklistComponent implements OnChanges {
|
|
|
2382
2394
|
"alias": "subscriptionId";
|
|
2383
2395
|
"required": false;
|
|
2384
2396
|
};
|
|
2397
|
+
"busy": {
|
|
2398
|
+
"alias": "busy";
|
|
2399
|
+
"required": false;
|
|
2400
|
+
};
|
|
2385
2401
|
}, {
|
|
2386
2402
|
"retry": "retry";
|
|
2403
|
+
"markDone": "markDone";
|
|
2387
2404
|
}, never, never, false, never>;
|
|
2388
2405
|
}
|
|
2389
2406
|
declare namespace resource_shared_components_module_d_exports {
|