@synopackageland/sdk 0.12.1 → 0.12.2

package/dist/src/context.d.ts

@@ -96,6 +96,7 @@ export declare function clientTimeout(requestTimeout?: number): number;
 export interface CallOptions {
     signal?: AbortSignal;
 }
+export type LaunchParams = Readonly<Record<string, string>>;
 export interface Context {
     requestTimeout?: number;
     authorization?: AuthorizationAccess;
@@ -115,6 +116,8 @@ export interface Context {
     portal?: PortalAccess;
     call<T = unknown>(method: string, params?: Record<string, unknown>, options?: CallOptions): Promise<T>;
     reopen(fn: () => void): () => void;
+    launchParams?: LaunchParams;
+    onLaunch?(fn: (params: LaunchParams) => void): () => void;
     locale: string;
     lang?: string;
     t?: (key: string, params?: Record<string, unknown>) => string;

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 export type * from './context';
 export { DEFAULT_REQUEST_TIMEOUT, clientTimeout, isFullPage } from './context';
 export { createStandaloneHost, createStandaloneContext } from './standalone';
+export { launchRoute, followLaunchRoute, dsmLaunchURL, MAX_LAUNCH_ROUTE } from './launch';
 export { createDsmSession } from './dsm/session.js';
 export type * from './delegate/long-running';
 export type * from './delegate/executor-setup';

package/dist/src/launch.d.ts

@@ -0,0 +1,23 @@
+import type { Context, LaunchParams } from './context';
+/** The longest route launchRoute returns. */
+export declare const MAX_LAUNCH_ROUTE = 2048;
+/**
+ * The App route in launch params' `route`: a path from the App root, the part
+ * a portal link puts after its `#`, such as `/a/notes/42`. One leading `/`, no
+ * backslash or control character, at most MAX_LAUNCH_ROUTE characters; any
+ * other value gives undefined. Hand it to the App's own router only.
+ */
+export declare function launchRoute(params?: LaunchParams): string | undefined;
+/**
+ * Runs navigate with the route of the launch that opened the DSM window, then
+ * with that of each later launch of the open window. Returns a function that
+ * stops following. A context without launch support follows nothing.
+ */
+export declare function followLaunchRoute(ctx: Partial<Pick<Context, 'launchParams' | 'onLaunch'>>, navigate: (route: string) => void): () => void;
+/**
+ * A DSM desktop link that opens the package's window with params, as
+ * `<origin>/?launchApp=SYNO.SDS.<package>.Instance&launchParam=…`. DSM
+ * url-decodes launchParam, splits it at `&` and `=`, then url-decodes each
+ * key and value, so each is encoded twice here.
+ */
+export declare function dsmLaunchURL(origin: string, packageId: string, params: LaunchParams): string;