@diagonal-hq/cli 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -157,6 +157,13 @@ export type PageAuthorizer =
     };
 
 export type PageDefinition = {
+  /**
+   * The page's identity, unique in the workspace: a camelCase name of at most
+   * 64 letters and digits that starts with a lowercase letter, such as
+   * `members`. Code links to the page as `Pages.<key>`. A file move keeps the
+   * key, and a key change is an identity change.
+   */
+  key: string;
   /** The URL pattern. Route parameters use `{name}`, for example `/members/{id}`. */
   route: string;
   /** The name in the admin. Defaults to the title. */

package/dist/sdk-contract.d.ts

@@ -1458,6 +1458,28 @@ type TaskNavigateOptions = {
   preserveState?: boolean;
 };
 
+type PageRefParams = Record<string, string | number>;
+
+type PageRef<
+  K extends string = string,
+  P extends PageRefParams | undefined = PageRefParams | undefined
+> = {
+  /** The page's key, from its `definePage` options. */
+  readonly key: K;
+  /** The page's id, or null when the page is not deployed or is paused. */
+  readonly id: string | null;
+  /** The deployed route pattern, e.g. `/members/{id}`, or null when the page is not deployed or is paused. */
+  readonly route: string | null;
+  /** The page's URL with `params` filled into the route, or null when the page has no route. */
+  url(...args: undefined extends P ? [params?: P] : [params: P]): string | null;
+  /** Navigate to the page with `params` filled into the route. A page without a route is ignored after a warning. */
+  navigate(
+    ...args: undefined extends P
+      ? [params?: P, options?: TaskNavigateOptions]
+      : [params: P, options?: TaskNavigateOptions]
+  ): void;
+};
+
 type SdkResourceReference = SdkResourceHandle | string | null | undefined;
 
 type SdkResourceHandle = Omit<SdkResource, keyof SdkResourceOperations>;
@@ -13800,6 +13822,8 @@ declare namespace Sdk {
   export type PageAliasCatalog = import("diagonal:sdk-internal").PageAliasCatalog;
   export type PageReference = import("diagonal:sdk-internal").PageReference;
   export type PageHandle = import("diagonal:sdk-internal").SdkPageHandle;
+  export type PageRefParams = import("diagonal:sdk-internal").PageRefParams;
+  export type PageRef<K extends string = string, P extends import("diagonal:sdk-internal").PageRefParams | undefined = import("diagonal:sdk-internal").PageRefParams | undefined> = import("diagonal:sdk-internal").PageRef<K, P>;
   export type ResourceType<TRecord extends import("diagonal:sdk-internal").ResourceRecord = import("diagonal:sdk-internal").ResourceRecord, TRelations extends import("diagonal:sdk-internal").ResourceRelationCatalog = import("diagonal:sdk-internal").ResourceRelationCatalog> = import("diagonal:sdk-internal").SdkResourceType<TRecord, TRelations>;
   export type ResourceRelationsFrom<TResource extends import("diagonal:sdk-internal").SdkResourceType> = import("diagonal:sdk-internal").ResourceRelationsFrom<TResource>;
   export type ResourceRelationPath<TResource extends import("diagonal:sdk-internal").SdkResourceType> = import("diagonal:sdk-internal").SdkResourceRelationPath<TResource>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diagonal-hq/cli",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "The diagonal CLI and the configuration helpers for file-based Diagonal workspaces.",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {