@pilotiq/pilotiq 0.7.1 → 0.8.0

package/dist/pageData/relationPages.d.ts

@@ -0,0 +1,172 @@
+import type { Pilotiq } from '../Pilotiq.js';
+import type { ResourceClass } from '../Resource.js';
+import { RelationManager, safeManagerPolicy as safeManagerPolicyImpl, type ManagerCanMethod as ManagerCanMethodType } from '../RelationManager.js';
+import { type RelationMode } from '../RelationManager.js';
+import { type RelationChainStep } from './breadcrumbs.js';
+/**
+ * Plan #11 — three scopes a single relation-manager URL space resolves to:
+ *
+ *   list:    GET    {base}/{slug}/:id/{rel}
+ *   create:  GET    {base}/{slug}/:id/{rel}/create
+ *   edit:    GET    {base}/{slug}/:id/{rel}/{childId}/edit
+ *
+ * Each carries enough state for `relationManagerData` to load the right
+ * parent + (for edit) child + form/table context. Submit-side handlers
+ * live in `routes.ts` and reuse `dispatchFormSubmit`.
+ */
+export type RelationManagerScope = {
+    kind: 'relation-list';
+    slug: string;
+    recordId: string;
+    relationship: string;
+    query?: Record<string, string>;
+} | {
+    kind: 'relation-create';
+    slug: string;
+    recordId: string;
+    relationship: string;
+    prefill?: {
+        values?: Record<string, unknown>;
+        errors?: Record<string, string[]>;
+    };
+} | {
+    kind: 'relation-view';
+    slug: string;
+    recordId: string;
+    relationship: string;
+    childId: string;
+} | {
+    kind: 'relation-edit';
+    slug: string;
+    recordId: string;
+    relationship: string;
+    childId: string;
+    prefill?: {
+        values?: Record<string, unknown>;
+        errors?: Record<string, string[]>;
+    };
+} | {
+    kind: 'nested-relation-list';
+    slug: string;
+    chain: [RelationChainStep, RelationChainStep];
+    query?: Record<string, string>;
+} | {
+    kind: 'nested-relation-create';
+    slug: string;
+    chain: [RelationChainStep, RelationChainStep];
+    prefill?: {
+        values?: Record<string, unknown>;
+        errors?: Record<string, string[]>;
+    };
+} | {
+    kind: 'nested-relation-view';
+    slug: string;
+    chain: [RelationChainStep, RelationChainStep];
+    childId: string;
+} | {
+    kind: 'nested-relation-edit';
+    slug: string;
+    chain: [RelationChainStep, RelationChainStep];
+    childId: string;
+    prefill?: {
+        values?: Record<string, unknown>;
+        errors?: Record<string, string[]>;
+    };
+};
+/** Phase B — one parent layer in a nested-resources URL chain. The list
+ *  of these identifies a path through the manager tree:
+ *    `[ { recordId: '123', relationship: 'comments' } ]` picks comment
+ *    "456 under post 123" when paired with `childId: '456'`. */
+/**
+ * Failure outcomes the data builder discriminates back to the route
+ * handler, which decides between 403 / 404 / HTML / JSON shapes.
+ *
+ *   `null`            — unknown panel / parent / manager / child;
+ *                        route returns 404
+ *   `{ ok: false, status: 403 }` — policy denied; route returns 403
+ *
+ * Success returns the schemaData payload directly (a record, not
+ * tagged) for parity with `resourceIndexData / resourceCreateData`.
+ */
+export type RelationManagerResult = Record<string, unknown> | {
+    ok: false;
+    status: 403;
+} | null;
+/**
+ * Discover the related Resource for a manager. Order:
+ *   1. `M.relatedResource` explicit override (skip discovery).
+ *   2. Rudder ORM convention: walk
+ *      `R.model.relations[manager.relationship].model()` and find
+ *      `cfg.resources[i].model === relatedModel`.
+ *   3. Otherwise undefined — caller must error or fall back.
+ *
+ * A returned Resource is the one whose `model` backs the related
+ * table. Callers use it for `Related.model.find(childId)`,
+ * `Related.canEdit(user, child)`, and the auto-wired form save handler.
+ */
+export declare function findRelatedResource(M: typeof RelationManager, R: ResourceClass, cfg: ReturnType<Pilotiq['getConfig']>): ResourceClass | undefined;
+/** Plan #11 — authorization predicate names a `RelationManager` carries.
+ *  Re-exported from `RelationManager.ts`. */
+export type ManagerCanMethod = ManagerCanMethodType;
+/** Plan #11 — authorize a relation-manager action with sensible defaults.
+ *  Re-exported from `RelationManager.ts` so external callers (route
+ *  handlers, third-party plugins) keep their existing import path. */
+export declare const safeManagerPolicy: typeof safeManagerPolicyImpl;
+/**
+ * Plan #11 — render data for the three relation-manager URL scopes.
+ * Mirrors the resource* builders' shape so routes and Vike +data hooks
+ * consume identical props. Authorization runs inline (parent
+ * `canAccess + canEdit(parent)` then manager-scoped predicate); IDOR
+ * check on `relation-edit` runs against the parent's relation query.
+ *
+ * Returns:
+ *   - `null` when panel / parent / manager / child don't exist.
+ *   - `{ ok: false, status: 403 }` when authorization denies.
+ *   - the props record on success (route picks SSR view / SPA prop
+ *     downstream).
+ */
+export declare function relationManagerData(pilotiq: Pilotiq, scope: RelationManagerScope, req?: unknown): Promise<RelationManagerResult>;
+/**
+ * Phase B — narrow `scope` discriminator for nested-relation-*. Lets
+ * the helpers below avoid restating the union for every parameter.
+ */
+type NestedRelationScope = Extract<RelationManagerScope, {
+    kind: `nested-relation-${string}`;
+}>;
+/**
+ * Phase B — chain walk result. Resolved layer-by-layer in
+ * `resolveRelationChain`; nested builders consume it. Failures bubble
+ * up as the same `{ ok: false, status: 403 }` / `null` shape the
+ * depth-1 path uses.
+ */
+export interface ResolvedChain {
+    R: ResourceClass;
+    parentRecord: unknown;
+    M1: typeof RelationManager;
+    Related1: ResourceClass;
+    child1: unknown;
+    child1Mode: RelationMode;
+    M2: typeof RelationManager;
+    Related2: ResourceClass | undefined;
+    child2Mode: RelationMode;
+}
+/**
+ * Phase B — resolve a depth-2 chain, running every auth + IDOR layer:
+ *   Layer 0 — top-level Resource: cluster gate, R.canAccess.
+ *   Layer 1 — parent record: R.canEdit(parent) (Phase A gate to manage relations).
+ *   Layer 2 — first manager M1: relationship discovered, related resource discovered.
+ *   IDOR #1 — child1 (the leaf parent) must belong to parentRecord under chain[0].relationship.
+ *   Layer 3 — M1.canView(child1, parent) (Filament-style: must be allowed
+ *             to view the child to drill into its sub-relations).
+ *   Layer 4 — second manager M2 lookup; relation type read off Related1.model.
+ *
+ * The leaf manager's per-scope predicate (canViewAny / canCreate /
+ * canView / canEdit) runs inside the per-scope builders below, since
+ * each predicate has different arguments.
+ */
+export declare function resolveRelationChain(pilotiq: Pilotiq, scope: NestedRelationScope, user: unknown): Promise<ResolvedChain | {
+    ok: false;
+    status: 403;
+} | null>;
+export {};
+//# sourceMappingURL=relationPages.d.ts.map

package/dist/pageData/relationPages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relationPages.d.ts","sourceRoot":"","sources":["../../src/pageData/relationPages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAiB,MAAM,eAAe,CAAA;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAanD,OAAO,EACL,eAAe,EACf,iBAAiB,IAAI,qBAAqB,EAC1C,KAAK,gBAAgB,IAAI,oBAAoB,EAE9C,MAAM,uBAAuB,CAAA;AAa9B,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAChF,OAAO,EASL,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAA;AA0CzB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,eAAe,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACjH;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAA;CAAE,GACpK;IAAE,IAAI,EAAE,eAAe,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAClG;IAAE,IAAI,EAAE,eAAe,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAA;CAAE,GAKrL;IAAE,IAAI,EAAE,sBAAsB,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAC/H;IAAE,IAAI,EAAE,wBAAwB,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAA;CAAE,GAClL;IAAE,IAAI,EAAE,sBAAsB,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAChH;IAAE,IAAI,EAAE,sBAAsB,CAAC;IAAG,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;KAAE,CAAA;CAAE,CAAA;AAEvM;;;gEAGgE;AAMhE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,qBAAqB,GAC7B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAE,GAC1B,IAAI,CAAA;AAER;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CACjC,CAAC,EAAI,OAAO,eAAe,EAC3B,CAAC,EAAI,aAAa,EAClB,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GACpC,aAAa,GAAG,SAAS,CAQ3B;AAkGD;6CAC6C;AAC7C,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,CAAA;AAEnD;;sEAEsE;AACtE,eAAO,MAAM,iBAAiB,8BAAwB,CAAA;AAEtD;;;;;;;;;;;;GAYG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAI,oBAAoB,EAC7B,GAAG,CAAC,EAAK,OAAO,GACf,OAAO,CAAC,qBAAqB,CAAC,CAkFhC;AAyWD;;;GAGG;AACH,KAAK,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,EAAE;IAAE,IAAI,EAAE,mBAAmB,MAAM,EAAE,CAAA;CAAE,CAAC,CAAA;AAE/F;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,EAAiB,aAAa,CAAA;IAC/B,YAAY,EAAM,OAAO,CAAA;IACzB,EAAE,EAAgB,OAAO,eAAe,CAAA;IACxC,QAAQ,EAAU,aAAa,CAAA;IAC/B,MAAM,EAAY,OAAO,CAAA;IACzB,UAAU,EAAQ,YAAY,CAAA;IAC9B,EAAE,EAAgB,OAAO,eAAe,CAAA;IACxC,QAAQ,EAAU,aAAa,GAAG,SAAS,CAAA;IAC3C,UAAU,EAAQ,YAAY,CAAA;CAC/B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,OAAO,EAChB,KAAK,EAAI,mBAAmB,EAC5B,IAAI,EAAK,OAAO,GACf,OAAO,CAAC,aAAa,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAE,GAAG,IAAI,CAAC,CAoE5D"}