@diagonal-hq/cli 0.2.0 → 0.3.0

package/dist/fields.generated.d.ts

@@ -371,7 +371,7 @@ export type RelationInverse = {
   settings?: Omit<RelationFieldSettings, 'inverse'> & { "max_connections"?: number | null };
 };
 
-/** A relation names its target resource by id or slug. The type defaults to `belongs_to`. */
+/** A relation names its target resource by slug, as `Resources.<Name>`. The type defaults to `belongs_to`. */
 export type RelationFieldOptions = Omit<BaseFieldOptions<RelationFieldSettings>, 'settings'> & { resource: string } & (
   | { type?: "belongs_to"; settings?: RelationFieldSettings }
   | { type: "belongs_to_many"; settings?: RelationFieldSettings & { "max_connections"?: number | null } }

package/dist/index.d.ts

@@ -76,13 +76,8 @@ export type ResourceDataApi = {
 export type ResourceDefinition<
   TFields extends Record<string, FieldDefinition> = Record<string, FieldDefinition>
 > = {
-  /**
-   * A lowercase UUID v7, for example '0199f000-0000-7000-8000-000000000001'.
-   * `diagonal check` suggests a new one when the id is not v7. Keep it
-   * stable: records and workflows refer to it.
-   */
-  id: string;
-  slug: string;
+  /** Only a platform resource reference sets `platform`. */
+  platform?: never;
   name: string;
   singularName: string;
   displayField?: Extract<keyof TFields, string>;
@@ -112,16 +107,22 @@ export type ResourceDefinition<
   capabilities?: ResourceCapabilities<TFields>;
 };
 
+/**
+ * A resource that the platform provisions and owns, such as the roles. The
+ * file gives it a `Resources` entry. The deploy does not change it.
+ */
+export type PlatformResourceDefinition = { platform: true };
+
 export declare function defineResource<const TFields extends Record<string, FieldDefinition>>(
-  resource: ResourceDefinition<TFields>
-): ResourceDefinition<TFields>;
+  resource: ResourceDefinition<TFields> | PlatformResourceDefinition
+): ResourceDefinition<TFields> | PlatformResourceDefinition;
 
 /** A TipTap document whose mentions resolve against the page's bound records. */
 export type PageMetaResolver = { readonly type: string; readonly [key: string]: unknown };
 
 export type PageRouteParam = {
-  /** The slug or id of the resource whose record the parameter names. */
-  resource: string;
+  /** The resource whose record the parameter names, as `Resources.<Name>`. */
+  resource: ResourceReference;
   /** The field the parameter matches. Defaults to the record id. */
   lookupField?: string | null;
   /** Relation fields to load with the record. */
@@ -133,8 +134,8 @@ export type PageAuthorizer =
   | null
   | 'authenticated'
   | {
-      /** The slug or id of the resource whose signed-in records may view the page. */
-      resource?: string | null;
+      /** The resource whose signed-in records may view the page, as `Resources.<Name>`. */
+      resource?: ResourceReference | null;
       /** Permission ids. A viewer needs any one of them. */
       permissions?: readonly string[];
     };
@@ -180,7 +181,11 @@ export type NavigationDefinition = { id: string; items: readonly NavigationItem[
 
 export declare function defineNavigation<const T extends NavigationDefinition>(navigation: T): T;
 
-/** The slug, name, or id of a resource. */
+/**
+ * The slug of a resource: its file name in `resources/`. Use `Resources.<Name>`
+ * from `@app/generated/resources`, which `diagonal check` writes, so the editor
+ * and the build catch a wrong name. A slug string builds with a warning.
+ */
 export type ResourceReference = string;
 
 export type WorkflowRunAs =

package/package.json

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