@x12i/memorix-descriptors 0.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,151 @@
+export type MemorixTarget = "entity" | "event" | "knowledge";
+export type MemorixIdField = "entityId" | "eventId" | "knowledgeId";
+export type MemorixSeedScope = {
+    domains: string[];
+    agents: string[];
+};
+export type DescriptorMutationOptions = {
+    dryRun?: boolean;
+    skipMongo?: boolean;
+    scope?: MemorixSeedScope;
+    reason?: string;
+    expectedVersion?: string;
+    allowCreateCollection?: boolean;
+    cascade?: boolean;
+    force?: boolean;
+    mode?: "soft" | "hard";
+};
+export type IntegrityIssue = {
+    code: string;
+    message: string;
+    path?: string;
+    severity: "error" | "warning";
+};
+export type DescriptorIntegrityReport = {
+    valid: boolean;
+    counts: {
+        entityDescriptors: number;
+        listDescriptors: number;
+        itemDescriptors: number;
+        completionMappings: number;
+    };
+    errors: IntegrityIssue[];
+    warnings: IntegrityIssue[];
+    orphans: {
+        collections: Array<{
+            database: string;
+            collection: string;
+            target: MemorixTarget;
+        }>;
+        danglingReferences: Array<{
+            from: string;
+            to: string;
+            kind: string;
+        }>;
+    };
+};
+export type CataloxWriteAction = {
+    catalogId: string;
+    itemId: string;
+    action: "create" | "update" | "delete";
+};
+export type MongoAction = {
+    action: string;
+    database: string;
+    collection: string;
+};
+export type DescriptorMutationError = {
+    code: string;
+    message: string;
+    path?: string;
+};
+export type DescriptorMutationResult<T = unknown> = {
+    ok: boolean;
+    dryRun: boolean;
+    data?: T;
+    warnings: string[];
+    errors: DescriptorMutationError[];
+    cataloxWrites: CataloxWriteAction[];
+    mongoActions?: MongoAction[];
+    integrity: DescriptorIntegrityReport;
+    rollbackPlan?: CataloxWriteAction[];
+};
+export type PropertyInput = {
+    label: string;
+    source: {
+        contentType: string;
+        path: string;
+    };
+    humanReadable: boolean;
+    sortable?: boolean;
+    filterable?: boolean;
+    list?: boolean;
+    item?: boolean;
+    valueType?: string;
+    format?: string;
+    metadata?: Record<string, unknown>;
+};
+export type RegisterEntityDescriptorInput = {
+    entityName: string;
+    target: MemorixTarget;
+    label?: string;
+    collectionPrefix: string;
+    canonicalContentType: {
+        key: string;
+        postfix: string;
+        collection?: string;
+        dataRoot?: string;
+    };
+    identity?: {
+        idField: MemorixIdField;
+    };
+    initialProperties?: Record<string, PropertyInput>;
+    scope?: MemorixSeedScope;
+    defaultListDescriptorId?: string;
+    defaultItemDescriptorId?: string;
+};
+export type ContentTypeInput = {
+    key: string;
+    postfix: string;
+    collection?: string;
+    dataRoot?: string;
+    isCanonical?: boolean;
+    effectiveDatePath?: string;
+    defaultMultiMatch?: {
+        extendFields?: "last" | "first" | "all" | "error" | "ignore";
+        array?: "last" | "first" | "all" | "error" | "ignore";
+    };
+};
+export type MemorixCompletionMapping = {
+    id: string;
+    name: string;
+    entityType: string;
+    target: MemorixTarget;
+    targetCollection: string;
+    targetSelector: {
+        sourceCollection: string;
+        idField: string;
+    };
+    source: {
+        databaseName: string;
+        collection: string;
+    };
+    match: {
+        targetPath: string;
+        sourcePath: string;
+    };
+    writeRoot: "data";
+    fields: Array<{
+        sourcePath: string;
+        targetPath: string;
+    }>;
+    onlyFillMissing?: boolean;
+    overwriteExisting?: boolean;
+};
+export type DescriptorSnapshot = {
+    entityDescriptors: Record<string, Record<string, unknown>>;
+    listDescriptors: Record<string, Record<string, unknown>>;
+    itemDescriptors: Record<string, Record<string, unknown>>;
+    completionMappings: Record<string, MemorixCompletionMapping>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,CAAC;AAEpE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE;QACN,iBAAiB,EAAE,MAAM,CAAC;QAC1B,eAAe,EAAE,MAAM,CAAC;QACxB,eAAe,EAAE,MAAM,CAAC;QACxB,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IACF,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,OAAO,EAAE;QACP,WAAW,EAAE,KAAK,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,EAAE,MAAM,CAAC;YACnB,MAAM,EAAE,aAAa,CAAC;SACvB,CAAC,CAAC;QACH,kBAAkB,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACvE,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAAC,CAAC,GAAG,OAAO,IAAI;IAClD,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,uBAAuB,EAAE,CAAC;IAClC,aAAa,EAAE,kBAAkB,EAAE,CAAC;IACpC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,SAAS,EAAE,yBAAyB,CAAC;IACrC,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE;QACN,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,QAAQ,CAAC,EAAE;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAClD,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE;QAClB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;QAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;KACvD,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,aAAa,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9D,MAAM,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IACrD,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC1D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACzD,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;CAC9D,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/validation/descriptor-validation.d.ts

@@ -0,0 +1,20 @@
+import type { MemorixEntityDescriptor, MemorixEntityListDescriptor, MemorixItemDescriptor, MemorixListDescriptor, MemorixPropertyDescriptor, MemorixWorkspaceListDescriptor } from "@x12i/memorix-retrieval";
+export declare class DescriptorValidationError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+export declare function validateMemorixEntityDescriptor(raw: Record<string, unknown>): MemorixEntityDescriptor;
+export declare function validatePropertyDescriptor(prop: MemorixPropertyDescriptor): void;
+export declare function isMemorixWorkspaceListDescriptor(descriptor: MemorixListDescriptor): descriptor is MemorixWorkspaceListDescriptor;
+export declare function validateMemorixWorkspaceListDescriptor(raw: Record<string, unknown>): MemorixWorkspaceListDescriptor;
+export declare function validateBootstrapEntityListDescriptor(raw: Record<string, unknown>): MemorixEntityListDescriptor;
+export declare function validateMemorixEntityListDescriptor(raw: Record<string, unknown>): MemorixEntityListDescriptor;
+export declare function validateMemorixListDescriptor(raw: Record<string, unknown>): MemorixListDescriptor;
+export declare function validateMemorixItemDescriptor(raw: Record<string, unknown>): MemorixItemDescriptor;
+export declare function assertListFieldsHumanReadable(list: MemorixEntityListDescriptor, entity: MemorixEntityDescriptor): void;
+export declare function parseDescriptorData(data: unknown): Record<string, unknown>;
+export declare function isKebabCase(value: string): boolean;
+export declare function singularizeEntityName(entityName: string): string;
+export declare function defaultListDescriptorId(entityName: string): string;
+export declare function defaultItemDescriptorId(entityName: string): string;
+//# sourceMappingURL=descriptor-validation.d.ts.map

package/dist/validation/descriptor-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptor-validation.d.ts","sourceRoot":"","sources":["../../src/validation/descriptor-validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,qBAAqB,EACrB,qBAAqB,EACrB,yBAAyB,EACzB,8BAA8B,EAC/B,MAAM,yBAAyB,CAAC;AAajC,qBAAa,yBAA0B,SAAQ,KAAK;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAK1C;AAID,wBAAgB,+BAA+B,CAC7C,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,uBAAuB,CA0DzB;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,yBAAyB,GAAG,IAAI,CAahF;AAaD,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,qBAAqB,GAChC,UAAU,IAAI,8BAA8B,CAE9C;AAED,wBAAgB,sCAAsC,CACpD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,8BAA8B,CAgBhC;AAED,wBAAgB,qCAAqC,CACnD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,2BAA2B,CAgB7B;AAED,wBAAgB,mCAAmC,CACjD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,2BAA2B,CAS7B;AAED,wBAAgB,6BAA6B,CAC3C,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,qBAAqB,CAKvB;AAED,wBAAgB,6BAA6B,CAC3C,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,qBAAqB,CAqBvB;AAED,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,2BAA2B,EACjC,MAAM,EAAE,uBAAuB,GAC9B,IAAI,CAgBN;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE1E;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD;AAED,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAWhE;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAElE;AAED,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAElE"}

package/dist/validation/descriptor-validation.js

@@ -0,0 +1,148 @@
+function assertObject(value, label) {
+    if (!value || typeof value !== "object" || Array.isArray(value)) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", `${label} must be an object`);
+    }
+    return value;
+}
+export class DescriptorValidationError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.name = "DescriptorValidationError";
+        this.code = code;
+    }
+}
+const VALID_TARGETS = ["entity", "event", "knowledge"];
+export function validateMemorixEntityDescriptor(raw) {
+    const d = raw;
+    if (!d.id || !d.entityName || !d.collectionPrefix) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires id, entityName, collectionPrefix");
+    }
+    if (!d.defaultListDescriptorId?.trim() || !d.defaultItemDescriptorId?.trim()) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires defaultListDescriptorId and defaultItemDescriptorId");
+    }
+    if (d.target && !VALID_TARGETS.includes(d.target)) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", 'Entity descriptor target must be "entity", "event", or "knowledge"');
+    }
+    if (!d.defaults?.canonicalContentType || !d.defaults?.dataRoot) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires defaults.canonicalContentType and dataRoot");
+    }
+    if (!d.contentTypes || typeof d.contentTypes !== "object") {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires contentTypes");
+    }
+    if (!d.properties || typeof d.properties !== "object") {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires properties");
+    }
+    for (const prop of Object.values(d.properties)) {
+        validatePropertyDescriptor(prop);
+    }
+    const canonicalTypes = Object.entries(d.contentTypes).filter(([, ct]) => ct.isCanonical);
+    if (canonicalTypes.length !== 1) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity descriptor requires exactly one content type with isCanonical: true");
+    }
+    const [canonicalName] = canonicalTypes[0];
+    if (canonicalName !== d.defaults.canonicalContentType) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "defaults.canonicalContentType must match the isCanonical content type key");
+    }
+    return d;
+}
+export function validatePropertyDescriptor(prop) {
+    if (!prop.label || !prop.source?.contentType || !prop.source?.path) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Property descriptor requires label and source");
+    }
+    if (prop.humanReadable !== true && prop.humanReadable !== false) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Property descriptor requires humanReadable boolean");
+    }
+}
+function validateListPagination(pagination) {
+    if (!pagination?.defaultLimit || !pagination?.maxLimit) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "List descriptor requires pagination limits");
+    }
+}
+export function isMemorixWorkspaceListDescriptor(descriptor) {
+    return descriptor.kind === "workspace";
+}
+export function validateMemorixWorkspaceListDescriptor(raw) {
+    const d = raw;
+    if (!d.id || d.kind !== "workspace") {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", 'Workspace list descriptor requires id and kind: "workspace"');
+    }
+    validateListPagination(d.pagination);
+    if (!Array.isArray(d.fields) || d.fields.length === 0) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "List descriptor requires fields");
+    }
+    return d;
+}
+export function validateBootstrapEntityListDescriptor(raw) {
+    const d = raw;
+    if (!d.id || !d.entity || !d.leadingContentType) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Entity list descriptor requires id, entity, leadingContentType");
+    }
+    validateListPagination(d.pagination);
+    if (!Array.isArray(d.fields)) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "List descriptor requires fields array");
+    }
+    return d;
+}
+export function validateMemorixEntityListDescriptor(raw) {
+    const d = validateBootstrapEntityListDescriptor(raw);
+    if (d.fields.length === 0) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "List descriptor requires fields");
+    }
+    return d;
+}
+export function validateMemorixListDescriptor(raw) {
+    if (raw.kind === "workspace") {
+        return validateMemorixWorkspaceListDescriptor(raw);
+    }
+    return validateMemorixEntityListDescriptor(raw);
+}
+export function validateMemorixItemDescriptor(raw) {
+    const d = raw;
+    if (!d.id || !d.entity || !d.identity?.idField) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Item descriptor requires id, entity, identity.idField");
+    }
+    if (!Array.isArray(d.contentTypes) || d.contentTypes.length === 0) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Item descriptor requires contentTypes");
+    }
+    if (!Array.isArray(d.sections) || d.sections.length === 0) {
+        throw new DescriptorValidationError("INVALID_DESCRIPTOR", "Item descriptor requires sections");
+    }
+    return d;
+}
+export function assertListFieldsHumanReadable(list, entity) {
+    for (const field of list.fields) {
+        const prop = entity.properties[field];
+        if (!prop) {
+            throw new DescriptorValidationError("UNKNOWN_FIELD", `List field "${field}" is not defined on entity "${entity.id}"`);
+        }
+        if (!prop.humanReadable) {
+            throw new DescriptorValidationError("NON_HUMAN_READABLE_LIST_FIELD", `List field "${field}" must have humanReadable=true`);
+        }
+    }
+}
+export function parseDescriptorData(data) {
+    return assertObject(data, "descriptor data");
+}
+export function isKebabCase(value) {
+    return /^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(value);
+}
+export function singularizeEntityName(entityName) {
+    if (entityName.endsWith("-stories")) {
+        return `${entityName.slice(0, -8)}-story`;
+    }
+    if (entityName.endsWith("ies")) {
+        return `${entityName.slice(0, -3)}y`;
+    }
+    if (entityName.endsWith("s") && !entityName.endsWith("ss")) {
+        return entityName.slice(0, -1);
+    }
+    return entityName;
+}
+export function defaultListDescriptorId(entityName) {
+    return `${entityName}-main-list`;
+}
+export function defaultItemDescriptorId(entityName) {
+    return `${singularizeEntityName(entityName)}-detail-item`;
+}
+//# sourceMappingURL=descriptor-validation.js.map

package/dist/validation/descriptor-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptor-validation.js","sourceRoot":"","sources":["../../src/validation/descriptor-validation.ts"],"names":[],"mappings":"AAUA,SAAS,YAAY,CAAC,KAAc,EAAE,KAAa;IACjD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,GAAG,KAAK,oBAAoB,CAC7B,CAAC;IACJ,CAAC;IACD,OAAO,KAAgC,CAAC;AAC1C,CAAC;AAED,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IACzC,IAAI,CAAS;IAEtB,YAAY,IAAY,EAAE,OAAe;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,aAAa,GAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AAExE,MAAM,UAAU,+BAA+B,CAC7C,GAA4B;IAE5B,MAAM,CAAC,GAAG,GAAyC,CAAC;IACpD,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC;QAClD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,uBAAuB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,uBAAuB,EAAE,IAAI,EAAE,EAAE,CAAC;QAC7E,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,gFAAgF,CACjF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAuB,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,oEAAoE,CACrE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,oBAAoB,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAC/D,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,OAAO,CAAC,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,yCAAyC,CAC1C,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,CAAC,CAAC,UAAU,IAAI,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QACtD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,uCAAuC,CACxC,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,CAC1D,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAC3B,CAAC;IACF,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,aAAa,CAAC,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC;IAC3C,IAAI,aAAa,KAAK,CAAC,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACtD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,IAA+B;IACxE,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;QACnE,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,+CAA+C,CAChD,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE,CAAC;QAChE,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,oDAAoD,CACrD,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAC7B,UAA2D;IAE3D,IAAI,CAAC,UAAU,EAAE,YAAY,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;QACvD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,4CAA4C,CAC7C,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,UAAiC;IAEjC,OAAQ,UAA6C,CAAC,IAAI,KAAK,WAAW,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,sCAAsC,CACpD,GAA4B;IAE5B,MAAM,CAAC,GAAG,GAAgD,CAAC;IAC3D,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACpC,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IACD,sBAAsB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,iCAAiC,CAClC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,qCAAqC,CACnD,GAA4B;IAE5B,MAAM,CAAC,GAAG,GAA6C,CAAC;IACxD,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;QAChD,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,gEAAgE,CACjE,CAAC;IACJ,CAAC;IACD,sBAAsB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,uCAAuC,CACxC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,mCAAmC,CACjD,GAA4B;IAE5B,MAAM,CAAC,GAAG,qCAAqC,CAAC,GAAG,CAAC,CAAC;IACrD,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,iCAAiC,CAClC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,GAA4B;IAE5B,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC7B,OAAO,sCAAsC,CAAC,GAAG,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,mCAAmC,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,GAA4B;IAE5B,MAAM,CAAC,GAAG,GAAuC,CAAC;IAClD,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;QAC/C,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,uDAAuD,CACxD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,uCAAuC,CACxC,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,yBAAyB,CACjC,oBAAoB,EACpB,mCAAmC,CACpC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,IAAiC,EACjC,MAA+B;IAE/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,yBAAyB,CACjC,eAAe,EACf,eAAe,KAAK,+BAA+B,MAAM,CAAC,EAAE,GAAG,CAChE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,MAAM,IAAI,yBAAyB,CACjC,+BAA+B,EAC/B,eAAe,KAAK,gCAAgC,CACrD,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAa;IAC/C,OAAO,YAAY,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,4BAA4B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACtD,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACpC,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC5C,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACvC,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,UAAkB;IACxD,OAAO,GAAG,UAAU,YAAY,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,UAAkB;IACxD,OAAO,GAAG,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC;AAC5D,CAAC"}