@_linked/core 2.12.0 → 2.13.0

package/lib/cjs/shapes/SHACL.d.ts

@@ -1,300 +0,0 @@
-import { type NodeReferenceValue } from '../utils/NodeReference.js';
-import { Shape } from './Shape.js';
-import type { PathExpr } from '../paths/PropertyPathExpr.js';
-import { type PropertyPathDecoratorInput } from '../paths/normalizePropertyPath.js';
-/**
- * Default identity root for shape & package IRIs. Public/first-party packages
- * publish under `linked.cm` (arch-02 §Domains). Packages may override per-package
- * via `linkedPackage(name, { baseUri })` — CN injects a workspace-scoped root
- * (`{workspaceSlug}.id.create.now`) for private packages; first-party packages
- * keep this default.
- */
-export declare const LINKED_DATA_ROOT: string;
-/**
- * Derive the public package slug — the npm package **basename** with the
- * `@scope/` dropped, kebab-cased (arch-02 §Slug rules: `^[a-z0-9]+(?:-[a-z0-9]+)*$`).
- * The package name is the single source of truth; there is no separate slug.
- *   `@_linked/core` → `core`, `@linked.cm/blog` → `blog`, `mypkg` → `mypkg`.
- *
- * Both first-party (`@_linked`) and community (`@linked.cm`) packages publish into
- * the one `linked.cm/{shape,pkg}` space, so the basename must be globally unique —
- * enforced by the registry, which reserves the (handful of) first-party names.
- */
-export declare function packageNameToSlug(packageName: string): string;
-/** Record a package's publish root. Called by `linkedPackage()`. */
-export declare function setPackagePublishConfig(packageName: string, config?: {
-    baseUri?: string;
-}): void;
-/** Public/first-party package IRI — arch-02: `{baseUri}pkg/{slug}`. */
-export declare function getPackageUri(packageName: string): string;
-type NodeKindConfig = NodeReferenceValue | NodeReferenceValue[];
-export type PropertyPathInput = PropertyPathDecoratorInput;
-export type PropertyPathInputList = PropertyPathDecoratorInput;
-/** Result object returned by PropertyShape.getResult() and NodeShape.properties. */
-export interface PropertyShapeResult {
-    id: string;
-    label: string;
-    path: PathExpr;
-    nodeKind?: NodeReferenceValue;
-    datatype?: NodeReferenceValue;
-    minCount?: number;
-    maxCount?: number;
-    name?: string;
-    description?: string;
-    order?: number;
-    group?: string;
-    class?: NodeReferenceValue;
-    in?: (NodeReferenceValue | string | number | boolean)[];
-    equals?: NodeReferenceValue;
-    disjoint?: NodeReferenceValue;
-    lessThan?: NodeReferenceValue;
-    lessThanOrEquals?: NodeReferenceValue;
-    hasValue?: NodeReferenceValue | string | number | boolean;
-    defaultValue?: unknown;
-    sortBy?: PathExpr;
-    valueShape?: NodeReferenceValue;
-}
-export interface NodeShapeConfig {
-    /**
-     * Set to true to close the shape. This means any target node of this shape
-     * that has properties outside the defined properties of this shape is invalid.
-     */
-    closed?: boolean;
-    /**
-     * Optional list of properties that are also permitted in addition to those explicitly listed by this shape.
-     */
-    ignoredProperties?: NodeReferenceValue[];
-}
-export interface LiteralPropertyShapeConfig extends PropertyShapeConfig {
-    nodeKind?: NodeReferenceValue;
-    /**
-     * Values of the configured property must be less than the values of this 'lessThan' property.
-     * Value is always a property IRI (pair constraint).
-     */
-    lessThan?: NodeReferenceValue;
-    /**
-     * Values of the configured property must be less than or equal the values of this 'lessThanOrEquals' property.
-     * Value is always a property IRI (pair constraint).
-     */
-    lessThanOrEquals?: NodeReferenceValue;
-    /**
-     * All values of this property must be higher than this number
-     */
-    minExclusive?: number | string;
-    /**
-     * All values of this property must be higher than or equal this number
-     */
-    minInclusive?: number;
-    /**
-     * All values of this property must be lower than this number
-     */
-    maxExclusive?: number;
-    /**
-     * All values of this property must be lower than or equal this number
-     */
-    maxInclusive?: number;
-    /**
-     * All literal values of this property must at least be this long
-     */
-    minLength?: number;
-    /**
-     * All literal values of this property must at most be this long
-     */
-    maxLength?: number;
-    /**
-     * All literal values of this property must match this regular expression
-     */
-    pattern?: RegExp;
-    /**
-     * All literal values of this property must have one of these languages as their language tag
-     */
-    languageIn?: string[];
-    /**
-     * No pair of values may use the same language tag.
-     */
-    uniqueLang?: boolean;
-    /**
-     * Each literal value of this property must use this datatype
-     */
-    datatype?: NodeReferenceValue;
-    /**
-     * Each value of the property must occur in this set.
-     * Use {id: '...'} for IRI nodes, or plain strings/numbers/booleans for literal values.
-     */
-    in?: (NodeReferenceValue | string | number | boolean)[];
-}
-export interface ObjectPropertyShapeConfig extends PropertyShapeConfig {
-    nodeKind?: NodeReferenceValue;
-    /**
-     * Each value of this property must have this class as its rdf:type
-     */
-    class?: NodeReferenceValue;
-    /**
-     * The shape that values of this property path need to confirm to.
-     * You need to provide a class that extends Shape.
-     */
-    shape?: typeof Shape | [string, string];
-    /**
-     * Marks this property as *containment* (composition): the value(s) are owned by the subject
-     * and the delete/update cascade removes the owned subtree.
-     */
-    contains?: boolean;
-}
-export interface PropertyShapeConfig {
-    /**
-     * The property path of this property shape.
-     */
-    path: PropertyPathInputList;
-    /**
-     * Indicates that this property must exist.
-     * Shorthand for minCount=1
-     */
-    required?: boolean;
-    /**
-     * Each value must be of this node type.
-     */
-    nodeKind?: NodeKindConfig;
-    /**
-     * Minimum number of values required
-     */
-    minCount?: number;
-    /**
-     * Maximum number of values allowed
-     */
-    maxCount?: number;
-    /**
-     * Values of the configured property must equal the values of this 'equals' property.
-     * Value is always a property IRI (pair constraint).
-     */
-    equals?: NodeReferenceValue;
-    /**
-     * Values of the configured property must differ from the values of this 'disjoint' property.
-     * Value is always a property IRI (pair constraint).
-     */
-    disjoint?: NodeReferenceValue;
-    /**
-     * At least one value of this property must equal the given value.
-     * Use {id: '...'} for IRI nodes, or a plain string for literal values.
-     */
-    hasValue?: NodeReferenceValue | string | number | boolean;
-    name?: string;
-    description?: string;
-    order?: number;
-    group?: string;
-    /**
-     * should correlate to the given datatype or class
-     */
-    defaultValue?: unknown;
-    /**
-     * Each value of the property must occur in this set.
-     * Use {id: '...'} for IRI nodes, or plain strings for literal values.
-     *
-     * @example
-     * in: ['ACTIVE', 'PENDING', 'CLOSED']
-     * in: [{id: 'http://example.org/StatusA'}, {id: 'http://example.org/StatusB'}]
-     */
-    in?: (NodeReferenceValue | string | number | boolean)[];
-    /**
-     * Values of the configured property path are sorted by the values of this property path.
-     */
-    sortBy?: PropertyPathInputList;
-}
-export interface ParameterConfig {
-    optional?: number;
-}
-export declare class NodeShape extends Shape {
-    static targetClass: NodeReferenceValue;
-    /** One-time keys for missing/invalid `propertyShapes` on superclass static `shape`. */
-    private static readonly _warnedMissingPropertyShapesKeys;
-    /**
-     * Returns `propertyShapes` when it is a real array; otherwise `[]` and logs once per
-     * `(ownerClassName, shapeId)` — common when a superclass `static shape` is a plain object
-     * or came from another `@_linked/core` copy without field initializers.
-     *
-     * Label for logs / dedupe keys when walking the shape class chain.
-     * Prefer `class.name` (almost always set for `class X {}`); if missing, use the static
-     * shape's `id` so diagnostics stay useful without vague "(anonymous)".
-     */
-    private static shapeOwnerLabel;
-    private static listPropertyShapesSafe;
-    private _label?;
-    description?: string;
-    targetClass?: NodeReferenceValue;
-    extends?: NodeReferenceValue;
-    /**
-     * Composition marker: instances of this shape are *dependent* — they have no
-     * independent existence and may be cascade-deleted when reached through a `contains` property.
-     */
-    dependent?: boolean;
-    /** sh:closed — target nodes with undeclared properties are invalid. */
-    closed?: boolean;
-    /** sh:ignoredProperties — extra properties permitted when the shape is closed. */
-    ignoredProperties?: NodeReferenceValue[];
-    private propertyShapes;
-    constructor(node?: string | NodeReferenceValue);
-    nodeRef?: NodeReferenceValue;
-    get label(): string;
-    set label(value: string);
-    get properties(): PropertyShapeResult[];
-    addPropertyShape(propertyShape: PropertyShape): void;
-    getPropertyShapes(includeSuperClasses?: boolean): PropertyShape[];
-    getUniquePropertyShapes(): PropertyShape[];
-    getPropertyShape(label: string, checkSubShapes?: boolean): PropertyShape;
-    validateNode(_node?: unknown): boolean;
-    equals(other: NodeShape): boolean;
-}
-export declare class PropertyShape extends Shape {
-    static targetClass: NodeReferenceValue;
-    private _label?;
-    path: PathExpr;
-    nodeKind?: NodeReferenceValue;
-    datatype?: NodeReferenceValue;
-    minCount?: number;
-    maxCount?: number;
-    name?: string;
-    description?: string;
-    order?: number;
-    group?: string;
-    class?: NodeReferenceValue;
-    in?: (NodeReferenceValue | string | number | boolean)[];
-    equalsConstraint?: NodeReferenceValue;
-    disjoint?: NodeReferenceValue;
-    lessThan?: NodeReferenceValue;
-    lessThanOrEquals?: NodeReferenceValue;
-    /** Value-range constraints (SHACL sh:minInclusive / sh:maxInclusive / sh:minExclusive / sh:maxExclusive). */
-    minInclusive?: number;
-    maxInclusive?: number;
-    minExclusive?: number | string;
-    maxExclusive?: number;
-    /** String-length constraints (SHACL sh:minLength / sh:maxLength). */
-    minLength?: number;
-    maxLength?: number;
-    /** Regex constraint (SHACL sh:pattern); serialized as its source string. */
-    pattern?: RegExp;
-    hasValueConstraint?: NodeReferenceValue | string | number | boolean;
-    defaultValue?: unknown;
-    sortBy?: PathExpr;
-    valueShape?: NodeReferenceValue;
-    /**
-     * Composition marker: the value(s) of this property are *owned* by the subject.
-     * The delete/update cascade follows this edge and removes the owned subtree.
-     */
-    contains?: boolean;
-    parentNodeShape?: NodeShape;
-    constructor();
-    get label(): string;
-    set label(value: string);
-    getResult(): PropertyShapeResult;
-    clone(): this;
-}
-export declare function registerPropertyShape(shape: NodeShape, propertyShape: PropertyShape): PropertyShape;
-export declare function createPropertyShape<Config extends LiteralPropertyShapeConfig | ObjectPropertyShapeConfig>(config: Config, propertyKey: string, defaultNodeKind?: NodeReferenceValue, shapeClass?: typeof Shape | [string, string]): PropertyShape;
-export declare function onShapeSetup(shapeClass: typeof Shape | [string, string], callback: (shape: NodeShape) => void, propertyName?: string, waitForSuperShapes?: boolean): void;
-export declare const literalProperty: (config: LiteralPropertyShapeConfig) => (target: any, propertyKey: string, _descriptor: PropertyDescriptor) => void;
-export declare const objectProperty: (config: ObjectPropertyShapeConfig) => (target: any, propertyKey: string, _descriptor: PropertyDescriptor) => void;
-export declare const linkedProperty: (config: ObjectPropertyShapeConfig | LiteralPropertyShapeConfig) => (target: any, propertyKey: string, _descriptor: PropertyDescriptor) => void;
-export declare function disallowProperty(target: any, propertyKey: string, _descriptor: PropertyDescriptor): void;
-export declare function getNodeShapeUri(packageName: string, shapeName: string): string;
-export declare function getAndClearCallbacks(nodeShapeId: string): ((shape: NodeShape) => void)[];
-export declare const addNodeShapeCallback: (nodeShapeId: string, callback: (shape: NodeShape) => void) => void;
-export {};